Skip to content

Commit 30786fb

Browse files
committed
Document active prop
1 parent 64c7697 commit 30786fb

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

docs/content/ActionList.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,12 @@ render(<SelectFields />)
297297
defaultValue="false"
298298
description="Indicate whether the item is selected. Only applies to items that can be selected."
299299
/>
300+
<PropsTableRow
301+
name="active"
302+
type="boolean"
303+
defaultValue="false"
304+
description="Indicate whether the item is active. There should never be more than one active item."
305+
/>
300306
<PropsTableRow
301307
name="disabled"
302308
type="boolean"
@@ -325,6 +331,12 @@ render(<SelectFields />)
325331
required
326332
type="React.ReactNode | ActionList.LeadingVisual | ActionList.Description | ActionList.TrailingVisual"
327333
/>
334+
<PropsTableRow
335+
name="active"
336+
type="boolean"
337+
defaultValue="false"
338+
description="Indicate whether the item is active. There should never be more than one active item."
339+
/>
328340
<PropsTableBasePropRows
329341
elementType="a"
330342
isPolymorphic

src/ActionList/Item.tsx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ export type ActionListItemProps = {
5555
* Is the `Item` is currently selected?
5656
*/
5757
selected?: boolean
58-
// TODO: Document `active` prop
58+
/**
59+
* Indicate whether the item is active. There should never be more than one active item.
60+
*/
5961
active?: boolean
6062
/**
6163
* Style variations associated with various `Item` types.

0 commit comments

Comments
 (0)