Select input component #1736
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,5 @@ | ||
| --- | ||
| '@primer/react': minor | ||
| --- | ||
|
|
||
| Adds a component for a native select input |
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
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,125 @@ | ||
| --- | ||
| componentId: select | ||
| title: Select | ||
|
There was a problem hiding this comment. I'm thinking maybe "SelectInput" is a better name. I'd love to hear what other reviewers think. There was a problem hiding this comment. Yep! I think so too. It kinda cements it as a Form component and not any fancy menu/overlay interface There was a problem hiding this comment. We only recently decided to avoid using |
||
| description: Use a select input when a user needs to select one option from a long list | ||
| status: Alpha | ||
| source: https://github.com/primer/react/blob/main/src/Select.tsx | ||
| storybook: '/react/storybook?path=/story/forms-select--default' | ||
| --- | ||
|
|
||
| import {Select, Text} from '@primer/react' | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Basic | ||
|
|
||
| ```jsx live | ||
| <> | ||
| <Text fontWeight="bold" fontSize={1} as="label" display="block" htmlFor="basic"> | ||
| Preferred Primer component interface | ||
| </Text> | ||
| <Select id="basic"> | ||
| <Select.Option value="figma">Figma</Select.Option> | ||
| <Select.Option value="css">Primer CSS</Select.Option> | ||
| <Select.Option value="prc">Primer React components</Select.Option> | ||
| <Select.Option value="pvc">Primer ViewComponents</Select.Option> | ||
| </Select> | ||
| </> | ||
| ``` | ||
|
|
||
| ### With grouped options | ||
|
|
||
| ```jsx live | ||
| <> | ||
| <Text fontWeight="bold" fontSize={1} as="label" display="block" htmlFor="grouped"> | ||
| Preferred Primer component interface | ||
| </Text> | ||
| <Select id="grouped"> | ||
| <Select.OptGroup label="GUI"> | ||
| <Select.Option value="figma">Figma</Select.Option> | ||
| </Select.OptGroup> | ||
| <Select.OptGroup label="Code"> | ||
| <Select.Option value="css">Primer CSS</Select.Option> | ||
| <Select.Option value="prc">Primer React components</Select.Option> | ||
| <Select.Option value="pvc">Primer ViewComponents</Select.Option> | ||
| </Select.OptGroup> | ||
| </Select> | ||
| </> | ||
| ``` | ||
|
|
||
| ### With a placeholder | ||
|
|
||
| ```jsx live | ||
| <> | ||
| <Text fontWeight="bold" fontSize={1} as="label" display="block" htmlFor="withPlaceholder"> | ||
| Preferred Primer component interface | ||
| </Text> | ||
| <Select id="withPlaceholder" placeholder="Pick an interface"> | ||
| <Select.Option value="figma">Figma</Select.Option> | ||
| <Select.Option value="css">Primer CSS</Select.Option> | ||
| <Select.Option value="prc">Primer React components</Select.Option> | ||
| <Select.Option value="pvc">Primer ViewComponents</Select.Option> | ||
| </Select> | ||
| </> | ||
| ``` | ||
|
|
||
| ## Props | ||
|
|
||
| ### Select | ||
|
|
||
| <PropsTable> | ||
| <PropsTableRow | ||
| name="block" | ||
| type="boolean" | ||
| defaultValue="false" | ||
| description={<>Creates a full width input element</>} | ||
| /> | ||
| <PropsTableRow | ||
| name="contrast" | ||
| type="boolean" | ||
| defaultValue="false" | ||
| description="Changes background color to a higher contrast color" | ||
| /> | ||
| <PropsTableRow | ||
| name="size" | ||
| type="'small' | 'medium' | 'large'" | ||
| description="Creates a smaller or larger input than the default." | ||
| /> | ||
| <PropsTableRow name="validationStatus" type="'warning' | 'error'" description="Style the input to match the status" /> | ||
| <PropsTablePassthroughPropsRow | ||
| elementName="select" | ||
| passthroughPropsLink={ | ||
| <Link href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attributes">MDN</Link> | ||
| } | ||
| /> | ||
|
|
||
| </PropsTable> | ||
|
|
||
| ### Select.OptGroup | ||
|
|
||
| The `Select.OptGroup` component accepts the same props as a native HTML [`<optgroup>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/optgroup). | ||
|
|
||
| ### Select.Option | ||
|
|
||
| The `Select.Option` component accepts the same props as a native HTML [`<option>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option). | ||
|
|
||
| ## Status | ||
|
|
||
| <ComponentChecklist | ||
| items={{ | ||
| propsDocumented: true, | ||
| noUnnecessaryDeps: true, | ||
| adaptsToThemes: true, | ||
| adaptsToScreenSizes: true, | ||
| fullTestCoverage: true, | ||
| usedInProduction: false, | ||
| usageExamplesDocumented: true, | ||
| hasStorybookStories: true, | ||
| designReviewed: false, | ||
| a11yReviewed: false, | ||
| stableApi: false, | ||
| addressedApiFeedback: false, | ||
| hasDesignGuidelines: false, | ||
| hasFigmaComponent: false | ||
| }} | ||
| /> | ||
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
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.
Selectwasn't added tonav.ymland is therefore not present in the sidebar menu. Was this intentional @mperrotti? You can only find this doc page via the search atm.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.
Not intentional. Adding now...