-
Notifications
You must be signed in to change notification settings - Fork 377
docs(tile): Adds content to tile component #9208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
88c4e78
Adds content to Tile examples
4f3d03a
Title
fe7fae9
Select Next
bf1f512
docs(tile): Adds content to tile component
f8ebafc
Update packages/react-core/src/components/Tile/examples/Tile.md
KaelanKhiatani 8d619b2
Update packages/react-core/src/components/Tile/examples/Tile.md
KaelanKhiatani d12ffd0
Update packages/react-core/src/next/components/Select.md
KaelanKhiatani 7a7e663
Update packages/react-core/src/components/Tile/examples/Tile.md
KaelanKhiatani 06863ff
Update packages/react-core/src/components/Tile/examples/Tile.md
KaelanKhiatani a9ec331
Update packages/react-core/src/next/components/Select.md
KaelanKhiatani bb41c6f
Update packages/react-core/src/next/components/Select.md
KaelanKhiatani a72e345
Update packages/react-core/src/next/components/Select.md
KaelanKhiatani 93be897
Update packages/react-core/src/next/components/Select.md
KaelanKhiatani 67e1ad4
Update packages/react-core/src/next/components/Select.md
KaelanKhiatani File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,90 @@ | ||
| --- | ||
edonehoo marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| id: Select | ||
| section: components | ||
| subsection: menus | ||
| cssPrefix: pf-v5-c-select | ||
| propComponents: | ||
| ['Select', 'SelectOption', 'SelectGroup', 'SelectList', 'MenuToggle', 'SelectToggleProps', 'SelectPopperProps'] | ||
| ouia: true | ||
| --- | ||
|
|
||
| import TimesIcon from '@patternfly/react-icons/dist/esm/icons/times-icon'; | ||
| import BellIcon from '@patternfly/react-icons/dist/esm/icons/bell-icon'; | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Single select | ||
| Single select dropdown menus allow your users to select a single option from a list of options. To change the name of the options, alter the ‘itemId’ property. | ||
|
|
||
| The initial text is listed in the select box to guide what options the user can select from. To change this text, alter the ‘React.useState’ property. | ||
|
|
||
| You can also add more options by adding `<SelectOption>`. You can follow the format of the preexisting options to ensure proper application. | ||
| ```ts file="./SelectBasic.tsx" | ||
|
|
||
| ``` | ||
|
|
||
KaelanKhiatani marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Option variations | ||
|
|
||
| Showcases different option variants and customizations that are commonly used in a select menu. For a more complete list, see the [Menu documentation](/components/menus/menu). | ||
|
|
||
| ```ts file="./SelectOptionVariations.tsx" | ||
|
|
||
| ### Grouped single select | ||
| You can change a single select component to have multiple groups. To do this, you have to add the component `<SelectGroup>` and list the desired options below. | ||
|
|
||
| You can also change the text above the group by inserting the property `label` and the desired name of the group by altering `<SelectGroup>`. | ||
| ```ts file="./SelectGrouped.tsx" | ||
|
|
||
| ``` | ||
|
|
||
| ### Checkbox select | ||
| You can use a checkbox select to allow your users to check multiple options in one select component. You can change the name of each checkbox by altering the `<SelectOption>` component. You can also change the name of the initial prompt in `<MenuToggle>`. | ||
|
|
||
| You also have the option to disable one of the checkmark options. To do this, you can pass the variable `isDisabled` inside of `<SelectOption>` | ||
| ```ts file="./SelectCheckbox.tsx" | ||
|
|
||
| ``` | ||
|
|
||
| ### Typeahead | ||
| A typeahead allows your users to type their response to narrow it down from the list of options. You can change the name of the checks by altering both the `ItemId` and `children` properties. | ||
|
|
||
| You can also change the name of the initial prompt under `placeholder` in `<MenuToggle>`. | ||
| ```ts file="./SelectTypeahead.tsx" | ||
|
|
||
| ``` | ||
|
|
||
KaelanKhiatani marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Typeahead with create option | ||
|
|
||
| ```ts file="./SelectTypeaheadCreatable.tsx" | ||
|
|
||
| ``` | ||
|
|
||
| ### Multiple typeahead | ||
| A typeahead can also be used to select multiple options from its list. | ||
| ```ts file="./SelectMultiTypeahead.tsx" | ||
|
|
||
| ``` | ||
|
|
||
KaelanKhiatani marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Typeahead with create option | ||
|
|
||
| ```ts file="./SelectMultiTypeaheadCreatable.tsx" | ||
|
|
||
| ``` | ||
|
|
||
KaelanKhiatani marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ### Multiple typeahead with checkboxes | ||
|
|
||
| ```ts file="./SelectMultiTypeaheadCheckbox.tsx" | ||
|
|
||
| ``` | ||
|
|
||
| ### View more | ||
|
|
||
| ```ts file="./SelectViewMore.tsx" | ||
|
|
||
| ``` | ||
|
|
||
| ### Footer | ||
|
|
||
| ```ts file="./SelectFooter.tsx" | ||
|
|
||
| ``` | ||
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
with v5, the "next" components are promoted, so this file is now contained here: https://github.com/patternfly/patternfly-react/blob/main/packages/react-core/src/components/Select/examples/Select.md
This is the link to the v5 page: https://staging.patternfly.org/components/menus/select
In VS code, make sure you're up to date with the 'main' branch and that the Select.md file matches what you see at these links, with the content you're adding. This may be something easier to look at together on a call?
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.
& content is missing from a few examples, but if you need help drafting that just lmk!
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.
We can do this tomorrow.