add comments to props

oxidecomputer · Sep 5, 2024 · 9b81b1e · 9b81b1e
1 parent 0e99ec3
commit 9b81b1e
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/app/table/columns/action-col.tsx b/app/table/columns/action-col.tsx
@@ -55,9 +55,15 @@ export const getActionsCol = <TData extends Record<string, unknown>>(
   }
 }
 
-type RowActionsProps = { id?: string | null; copyIdLabel?: string; actions?: MenuAction[] }
+type RowActionsProps = {
+  /** If id is provided, a `Copy ID` menu item will be automatically included. */
+  id?: string | null
+  /** Use copyIdLabel to override the default label. */
+  copyIdLabel?: string
+  actions?: MenuAction[]
+}
 
-export const RowActions = ({ id, copyIdLabel, actions }: RowActionsProps) => {
+export const RowActions = ({ id, copyIdLabel = 'Copy ID', actions }: RowActionsProps) => {
   return (
     <DropdownMenu.Root>
       {/* TODO: This name should not suck; future us, make it so! */}
@@ -78,7 +84,7 @@ export const RowActions = ({ id, copyIdLabel, actions }: RowActionsProps) => {
                 window.navigator.clipboard.writeText(id)
               }}
             >
-              {copyIdLabel || 'Copy ID'}
+              {copyIdLabel}
             </DropdownMenu.Item>
           )}
           {actions?.map((action) => {