Deprecate ActionList v1 & Promote drafts/ActionList v2 #1893
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,152 @@ | ||||||
| --- | ||||||
| '@primer/react': major | ||||||
| --- | ||||||
|
|
||||||
| ### ActionList | ||||||
|
|
||||||
| ActionList now ships a composable API. | ||||||
|
|
||||||
| See full list of props and examples: https://primer.style/react/ActionList | ||||||
|
|
||||||
| <table> | ||||||
| <tr> | ||||||
| <th> Before </th> <th> After </th> | ||||||
|
There was a problem hiding this comment. I'm making the following change in the tech preview post, as I think it makes it more obvious.. what do you think?
Suggested change
|
||||||
| </tr> | ||||||
| <tr> | ||||||
| <td valign="top"> | ||||||
|
|
||||||
| ```jsx | ||||||
| <ActionList | ||||||
| items={[ | ||||||
| {text: 'New file'}, | ||||||
| {text: 'Copy link'}, | ||||||
| {text: 'Edit file'}, | ||||||
| ActionList.Divider, | ||||||
| {text: 'Delete file', variant: 'danger'} | ||||||
| ]} | ||||||
| /> | ||||||
| ``` | ||||||
|
|
||||||
| </td> | ||||||
| <td valign="top"> | ||||||
|
|
||||||
| ```jsx | ||||||
| <ActionList> | ||||||
| <ActionList.Item>New file</ActionList.Item> | ||||||
| <ActionList.Item>Copy link</ActionList.Item> | ||||||
| <ActionList.Item>Edit file</ActionList.Item> | ||||||
| <ActionList.Divider /> | ||||||
| <ActionList.Item variant="danger">Delete file</ActionList.Item> | ||||||
| </ActionList> | ||||||
| ``` | ||||||
|
|
||||||
| </td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td valign="top"> | ||||||
|
|
||||||
| ```jsx | ||||||
| <ActionList | ||||||
| showItemDividers | ||||||
| items={[ | ||||||
| { | ||||||
| key: '0', | ||||||
| leadingVisual: LinkIcon, | ||||||
| text: 'github/primer' | ||||||
| }, | ||||||
| { | ||||||
| key: '1', | ||||||
| leadingVisual: () => <Avatar src="https://github.com/mona.png" />, | ||||||
| text: 'mona', | ||||||
| description: 'Monalisa Octocat', | ||||||
| descriptionVariant: 'block' | ||||||
| }, | ||||||
| { | ||||||
| key: '2', | ||||||
| leadingVisual: GearIcon, | ||||||
| text: 'View Settings', | ||||||
| trailingVisual: ArrowRightIcon | ||||||
| } | ||||||
| ]} | ||||||
| /> | ||||||
| ``` | ||||||
|
|
||||||
| </td> | ||||||
| <td valign="top"> | ||||||
|
|
||||||
| ```jsx | ||||||
| <ActionList showDividers> | ||||||
| <ActionList.Item> | ||||||
| <ActionList.LeadingVisual> | ||||||
| <LinkIcon /> | ||||||
| </ActionList.LeadingVisual> | ||||||
| github/primer | ||||||
| </ActionList.Item> | ||||||
| <ActionList.Item> | ||||||
| <ActionList.LeadingVisual> | ||||||
| <Avatar src="https://github.com/mona.png" /> | ||||||
| </ActionList.LeadingVisual> | ||||||
| mona | ||||||
| <ActionList.Description variant="block">Monalisa Octocat</ActionList.Description> | ||||||
| </ActionList.Item> | ||||||
| <ActionList.Item> | ||||||
| <ActionList.LeadingVisual> | ||||||
| <GearIcon /> | ||||||
| </ActionList.LeadingVisual> | ||||||
| View settings | ||||||
| <ActionList.TrailingVisual> | ||||||
| <ArrowRightIcon /> | ||||||
| </ActionList.TrailingVisual> | ||||||
| </ActionList.Item> | ||||||
| </ActionList> | ||||||
| ``` | ||||||
|
|
||||||
| </td> | ||||||
| </tr> | ||||||
| <tr> | ||||||
| <td valign="top"> | ||||||
|
|
||||||
| ```jsx | ||||||
| <ActionList | ||||||
| groupMetadata={[ | ||||||
| {groupId: '0', header: {title: 'Live query'}}, | ||||||
| {groupId: '1', header: {title: 'Layout'}} | ||||||
| ]} | ||||||
| items={[ | ||||||
| {key: '0', text: 'repo:github/github', groupId: '0'}, | ||||||
| {key: '1', text: 'Table', groupId: '1'}, | ||||||
| {key: '2', text: 'Board', groupId: '1'}, | ||||||
| {key: '3', text: 'View settings'} | ||||||
| ]} | ||||||
| /> | ||||||
| ``` | ||||||
|
|
||||||
| </td> | ||||||
| <td valign="top"> | ||||||
|
|
||||||
| ```jsx | ||||||
| <ActionList> | ||||||
| <ActionList.Group title="Live query"> | ||||||
| <ActionList.Item>repo:github/github</ActionList.Item> | ||||||
| </ActionList.Group> | ||||||
| <ActionList.Divider /> | ||||||
|
|
||||||
| <ActionList.Group title="Layout"> | ||||||
| <ActionList.Item>Table</ActionList.Item> | ||||||
| <ActionList.Item>Board Description></ActionList.Item> | ||||||
| </ActionList.Group> | ||||||
| <ActionList.Divider /> | ||||||
|
|
||||||
| <ActionList.Item>View settings</ActionList.Item> | ||||||
| </ActionList> | ||||||
| ``` | ||||||
|
|
||||||
| </td> | ||||||
| </tr> | ||||||
| </table> | ||||||
|
|
||||||
| To continue to use the deprecated API for now, change the import path to `@primer/react/deprecated`: | ||||||
|
|
||||||
| ```js | ||||||
| import {ActionList} from '@primer/react/deprecated' | ||||||
| ``` | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to earlier comment, I think we should rephrase this to say the previous ActionList has been superseded and has other benefits, as a way to encourage people to upgrade sooner.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!