-
Notifications
You must be signed in to change notification settings - Fork 214
Add documentation for Tile component #1971
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| title: "Tiles" | ||
| description: "Display visual previews with titles and descriptions in a grid layout." | ||
| keywords: ["tiles", "visual preview", "grid", "showcase"] | ||
| --- | ||
|
|
||
| Use tiles to create visual showcase elements with a patterned background, title, and description. Tiles are ideal for displaying component previews, feature highlights, or navigation items in a grid layout. | ||
|
|
||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
|
|
||
| ```mdx Tile example | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
| ``` | ||
|
|
||
| ## Grid layout | ||
|
|
||
| Combine tiles with the [Columns component](/components/columns) to create a responsive grid of visual previews. | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| <Columns cols={3}> | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
| </Columns> | ||
|
|
||
| ```mdx Grid layout example | ||
| <Columns cols={3}> | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
| </Tile> | ||
| <Tile href="/components/accordions" title="Accordion" description="2 variants"> | ||
| <img src="/images/tiles/accordion-light.svg" className="block dark:hidden" /> | ||
| <img src="/images/tiles/accordion-dark.svg" className="hidden dark:block" /> | ||
ethanpalm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| </Tile> | ||
| </Columns> | ||
| ``` | ||
|
|
||
| ## Properties | ||
|
|
||
| <ResponseField name="href" type="string" required> | ||
| URL to navigate to when the tile is clicked. | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="title" type="string"> | ||
| The title displayed below the tile preview. | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="description" type="string"> | ||
| A short description displayed below the title. | ||
| </ResponseField> | ||
|
|
||
| <ResponseField name="children" type="React.ReactNode" required> | ||
| Content displayed inside the tile preview area, typically images or SVGs. | ||
| </ResponseField> | ||
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.