index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/progress-bar.mdx | ---
title: Progress bar
shortDescription: Used to visually represent the completion of a task or operation.
category: Feedback indicators
releasedIn: 1.8.0
keywords:
- ProgressBar
- progress indicator
- progress bar
- loading
examples:
- fileName: progress-bar-default.tsx
title: Default
description: U... | 500 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/skeleton-body-text.mdx | ---
title: Skeleton body text
shortDescription: Provides a low fidelity representation of content before it appears, improving perceived load times.
category: Feedback indicators
releasedIn: 1.7.0
keywords:
- SkeletonBodyText
- skeleton
- loading
- page
examples:
- fileName: skeleton-body-text-default.tsx
... | 501 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/skeleton-display-text.mdx | ---
title: Skeleton display text
shortDescription: Provides a low fidelity representation of content before it appears, improving perceived load times.
category: Feedback indicators
releasedIn: 1.7.0
keywords:
- SkeletonDisplayText
- skeleton
- loading
- page
examples:
- fileName: skeleton-display-text-medium... | 502 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/skeleton-page.mdx | ---
title: Skeleton page
shortDescription: Used with other skeleton loading components to provide a low fidelity representation of the UI before content appears.
category: Feedback indicators
releasedIn: 1.7.0
keywords:
- SkeletonPage
- skeleton
- loading
- page
examples:
- fileName: skeleton-page-with-dynami... | 503 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/skeleton-tabs.mdx | ---
title: Skeleton tabs
shortDescription: Provides a low fidelity representation of content before it appears, improving perceived load times.
category: Feedback indicators
releasedIn: 9.0
keywords:
- SkeletonTabs
- skeleton
- loading
- page
examples:
- fileName: skeleton-tabs-default.tsx
title: Default
... | 504 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/skeleton-thumbnail.mdx | ---
title: Skeleton thumbnail
shortDescription: Provides a low fidelity representation of an image before it appears, improving perceived load times.
category: Feedback indicators
releasedIn: 3.7.2
keywords:
- SkeletonThumbnail
- skeleton
- loading
- page
examples:
- fileName: skeleton-thumbnail-medium.tsx
... | 505 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/spinner.mdx | ---
title: Spinner
shortDescription: Used to notify merchants that their action is being processed. Used for content that can’t be represented with skeleton loading components.
category: Feedback indicators
releasedIn: 1.7.0
keywords:
- spinner
- loader
- loading
- progress indicator
examples:
- fileName: spi... | 506 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/feedback-indicators/toast.mdx | ---
title: Toast
shortDescription: A non-disruptive message that provides quick feedback on the outcome of an action.
category: Feedback indicators
keywords:
- toast
- flash message
- snackbar
- notification bar
- temporary feedback
- timed feedback
- message
- overlay
- popup
- iframe
- duration
... | 507 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/images-and-icons/avatar.mdx | ---
title: Avatar
shortDescription: Used to show a thumbnail representation of an individual or business in the interface.
category: Images and icons
keywords:
- photo
- profile
- picture
- thumbnail
- default face
- face picture
- customer avatar
- customer face
- customer picture
- business face
... | 508 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/images-and-icons/icon.mdx | ---
title: Icon
shortDescription: Used to visually communicate core parts of the product and available actions, acting as wayfinding tools.
category: Images and icons
keywords:
- iconography
- visual indicator
- svg
- icon background
- accessible icons
- icon alternative text
- alt text
- alternative te... | 509 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/images-and-icons/index.mdx | ---
title: Images and icons
shortDescription: Represent visual content, such as avatars and thumbnails for images or video.
expanded: true
order: 4
previewImg: /images/components/images-and-icons.png
---
# {frontmatter.title}
<Lede>
Represent visual content, such as avatars and thumbnails for images or video.
</Led... | 510 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/images-and-icons/keyboard-key.mdx | ---
title: Keyboard key
shortDescription: Used to educate merchants about keyboard shortcuts.
category: Images and icons
keywords:
- KeyboardKey
- shortcuts
- hotkey
- hot key
- keyboard shortcuts
- keyboard letter
- hotkey combinations
examples:
- fileName: keyboard-key-default.tsx
title: Default
... | 511 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/images-and-icons/thumbnail.mdx | ---
title: Thumbnail
shortDescription: Used as a visual anchor and identifier for an object, along with text to provide context.
category: Images and icons
keywords:
- photo
- picture
- image
- small thumbnail
- medium thumbnail
- large thumbnail
- image preview
examples:
- fileName: thumbnail-default.t... | 512 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/images-and-icons/video-thumbnail.mdx | ---
title: Video thumbnail
shortDescription: A clickable placeholder image that opens a video player within a modal or full screen when clicked.
category: Images and icons
keywords:
- video
- VideoThumbnail
- updates
- new features
- video thumbnail
- feature thumbnail
- education
- contextual learning ... | 513 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/bleed.mdx | ---
title: Bleed
shortDescription: Applies negative margin to a layout, extending it to the edge of the screen on small screens.
category: Layout and structure
keywords:
- layout
examples:
- fileName: bleed-horizontal.tsx
title: Horizontal
description: >-
Content will bleed horizontally into the surro... | 514 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/block-stack.mdx | ---
title: Block stack
category: Layout and structure
keywords:
- layout
- stack spacing
- vertical centering
- fill available space
- fill space
- equal width
- right-aligned stack
- stack layout
examples:
- fileName: block-stack-with-gap.tsx
title: Gap
description: >-
Control the verti... | 515 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/box.mdx | ---
title: Box
category: Layout and structure
keywords:
- layout
- box
- responsive
- tokens
examples:
- fileName: box-with-color.tsx
title: Color
description: >-
Background color of box and text color inside a box can be adjusted using the [Color tokens](https://polaris.shopify.com/tokens/color... | 516 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/callout-card.mdx | ---
title: Callout card
category: Layout and structure
keywords:
- CalloutCard
- actionable
- updates
- new features
- call out card
- sales channel card
- feature card
- callout card heading
- callout card body content
- callout card text
- callout card cta
- callout card call to action
- cal... | 517 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/card.mdx | ---
title: Card
shortDescription: Used to group similar concepts and tasks together for easier scanning and reading.
category: Layout and structure
keywords:
- layout
- card
- responsive
- container
- box
- grid
- panel
- card with call to action in the footer
- card with call to action in the heading... | 518 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/divider.mdx | ---
title: Divider
category: Layout and structure
keywords:
- layout
- divider
- border
examples:
- fileName: divider-with-border-color.tsx
title: Color
description: Divider border color can be adjusted using the [Color tokens](https://polaris.shopify.com/tokens/color).
previewImg: /images/components/la... | 519 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/empty-state.mdx | ---
title: Empty state
category: Layout and structure
keywords:
- EmptyState
- lander
- welcome
- explain features
- describe features
- educate about features
- merchant education
- educational opportunity
- educational opportunities
- illustration on pages
- empty layouts
- empty states
- st... | 520 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/form-layout.mdx | ---
title: Form layout
shortDescription: Manages the layout of all forms and fields within it. Used for the layout of new forms and managing the layout of all forms.
category: Layout and structure
keywords:
- FormLayout
- Group
- responsive
- no grid
- stack fields
- vertical
- vertically
- arrange fiel... | 521 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/grid.mdx | ---
title: Grid
category: Layout and structure
keywords:
- one column
- two column
- three column
- column
- row
- column layouts
- grid layouts
- containers
- full width containers
- css grid
examples:
- fileName: grid-two-column.tsx
title: Two column
description: Use to create a two colu... | 522 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/index.mdx | ---
title: Layout and structure
shortDescription: The arrangement of elements on a page that helps merchants understand and find information to complete their goals.
expanded: true
order: 2
primitives:
- Bleed
- Block stack
- Box
- Divider
- Grid
- Inline stack
- Inline grid
previewImg: /images/components... | 523 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/inline-grid.mdx | ---
title: Inline grid
category: Layout and structure
keywords:
- layout
- columns
- grid
- responsive
examples:
- fileName: inline-grid-with-varying-gap.tsx
title: Gap
description: >-
Use the `gap` prop to set the amount of space between columns. The `gap` prop supports responsive spacing with ... | 524 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/inline-stack.mdx | ---
title: Inline stack
category: Layout and structure
keywords:
- layout
- inline
- flexbox
- flex
- responsive
- flexible items
- row of components
- rows
- vertical centering
- horizontal row of components
- stack
examples:
- fileName: inline-stack-with-non-wrapping.tsx
title: Non-wrappin... | 525 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/layout.mdx | ---
title: Layout
shortDescription: A structural component used to group other components. Creates consistent spacing and helps layout stack and scale responsively.
category: Layout and structure
keywords:
- one column
- two column
- three column
- column
- annotated
- page
- column layouts
- containers... | 526 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/media-card.mdx | ---
title: Media card
shortDescription: Provides a container for introductory or highlight information. Often used in a grid to present related content.
category: Layout and structure
keywords:
- MediaCard
- actionable
- updates
- new features
- Media card
- image card
- feature card
- card with thumbna... | 527 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/layout-and-structure/page.mdx | ---
title: Page
shortDescription: Used to build the layout of a page in the Shopify admin. A flexible container for composing pages consistently.
category: Layout and structure
keywords:
- page
- breadcrumbs
- view
- title
- titlebar
- backAction
- pagination
- page with all header elements
- page wit... | 528 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/action-list.mdx | ---
title: Action list
category: Lists
keywords:
- ActionList
- dropdown
- drop down
- popover
- pop over
- menu
- drop-down
- select
- options
examples:
- fileName: action-list-in-a-popover.tsx
title: In a popover
description: Use for the least important actions so merchants aren’t distract... | 529 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/description-list.mdx | ---
title: Description list
shortDescription: Used to present pairs of related information, like terms and definitions, or names and values, in a list format.
category: Lists
keywords:
- DescriptionList
- glossary
- description
- list terms
- list and define terms
- item lists
- text lists
- list of ter... | 530 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/index.mdx | ---
title: Lists
expanded: true
order: 8
previewImg: /images/components/lists.png
---
# {frontmatter.title}
<Lede>
Provide merchants with easy-to-use interfaces for selecting options, organizing information, and interacting with data.
</Lede>
<RichCardGrid cards={posts} />
| 531 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/list.mdx | ---
title: List
category: Lists
keywords:
- bulleted lists
- numbered lists
- icon lists
- list items
- text lists
- text-only lists
examples:
- fileName: list-bulleted.tsx
title: Bulleted
description: Use for a text-only list of related items that don’t need to be in a specific order and don’t re... | 532 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/listbox.mdx | ---
title: Listbox
category: Lists
keywords:
- list
- listbox
- list box
- interactive list
examples:
- fileName: listbox-default.tsx
title: Default
description: Basic implementation of a control element used to let merchants select options
- fileName: listbox-with-loading.tsx
title: With Loadin... | 533 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/option-list.mdx | ---
title: Option list
category: Lists
keywords:
- option list
- choices
- decision
- list
- list of tags
- list of collections
- collections lists
- collection lists
- list selection
examples:
- fileName: option-list-default.tsx
title: Default
description: Use for a group of similar selecta... | 534 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/resource-item.mdx | ---
title: Resource item
category: Lists
keywords:
- ResourceItem
- resource item
- collections
- items
- objects
- list of products
- list of orders
- product lists
- order lists
- collections lists
- collection lists
- list of collections
- product listings list
- channel lists
- resourc... | 535 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/lists/resource-list.mdx | ---
title: Resource list
category: Lists
keywords:
- ResourceList
- collections
- items
- objects
- list of products
- list of orders
- product lists
- order lists
- collections lists
- collection lists
- list of collections
- product listings list
- channel lists
- resource list attributes
... | 536 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/footer-help.mdx | ---
title: Footer help
category: Navigation
keywords:
- FooterHelp
- learn more about
- help documentation links
- links to help documentation
- link to help documentation
- footer help boxes
- educate about features
- merchant education
- educational opportunity
- educating
- teaching
examples:
... | 537 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/fullscreen-bar.mdx | ---
title: Fullscreen bar
category: Navigation
keywords:
- topbar
- top bar
- header
- bar
- app
examples:
- fileName: fullscreen-bar-with-children.tsx
title: With children
description: Use to provide structure for the top of an application while in fullscreen mode.
- fileName: fullscreen-bar-no-c... | 538 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/index.mdx | ---
title: Navigation
expanded: true
order: 9
previewImg: /images/components/navigation.png
---
# {frontmatter.title}
<Lede>
Access resources and move between sections, pages, or views in a structured and intuitive way.
</Lede>
<RichCardGrid cards={posts} />
| 539 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/link.mdx | ---
title: Link
category: Navigation
keywords:
- URL
- linklist
- link list
- embed
- actions
- pathways
- deep link
- text link
- plain button
- plain call to action
- plain cta
- embeddd action
- action in text
- hyperlink
- secondary actions
- secondary cta
- secondary call to actio... | 540 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/navigation.mdx | ---
title: Navigation
category: Navigation
keywords:
- navigation
- nav
- links
- primary navigation
- main navigation
- frame
- sidebar
- side bar
examples:
- fileName: navigation-default.tsx
title: Default
description: Use to present a navigation menu in the [frame](https://polaris.shopify.c... | 541 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/pagination.mdx | ---
title: Pagination
category: Navigation
keywords:
- lists
- detail
- page
- label
- pager
- previous
- next
- navigation between pages
- page arrows
- list navigation
- list arrows
- list pagination
- list pages
- previous next buttons
- previous buttons
- next buttons
examples:
- f... | 542 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/tabs.mdx | ---
title: Tabs
shortDescription: Used to alternate among related views within the same context.
category: Navigation
keywords:
- layout
- navigate
- organize
- list views
- list filters
- fitted tabs
- segmented controls
- scrollable
examples:
- fileName: tabs-default.tsx
title: Default
descr... | 543 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/navigation/top-bar.mdx | ---
title: Top bar
shortDescription: Appears at the top of the page and is used to brand and navigate major applications areas.
category: Navigation
keywords:
- global chrome
- global features
- topbar
- top bar
- header
- nav bar
- bar
- navbar
- brand
- search
- user
- menu
- logo
examples:
... | 544 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/overlays/index.mdx | ---
title: Overlays
expanded: true
order: 10
previewImg: /images/components/overlays.png
---
# {frontmatter.title}
<Lede>
Display contextual elements on top of the main admin interface that provide additional information or functionality.
</Lede>
<RichCardGrid cards={posts} />
| 545 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/overlays/modal.mdx | ---
title: Modal
shortDescription: Used to interrupt merchants with urgent information, details, or actions.
category: Overlays
keywords:
- modal
- src
- open
- title
- width
- height
- primary action
- secondary action
- tertiary action
- destructive action
- footer
- instant
- sectioned
- ... | 546 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/overlays/popover.mdx | ---
title: Popover
shortDescription: Small overlays that open on demand and close when the merchant interacts with any other part of Shopify. Used to surface secondary information or actions.
category: Overlays
keywords:
- interactive
- container
- dropdown
- drop down
- drop-down
- popover
- pop over
-... | 547 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/overlays/tooltip.mdx | ---
title: Tooltip
category: Overlays
keywords:
- info
- help
- popover
- infotip
- hint
- small popover
- hover
- tap
examples:
- fileName: tooltip-default.tsx
title: Default
description: Use only when necessary to provide an explanation for an interface element.
- fileName: tooltip-visible... | 548 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/autocomplete.mdx | ---
title: Autocomplete
category: Selection and input
keywords:
- autocomplete
- searchable
- typeahead
- combobox
- listbox
examples:
- fileName: autocomplete-default.tsx
title: Default
description: Use to help merchants complete text input quickly from a list of options.
- fileName: autocomplete... | 549 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/checkbox.mdx | ---
title: Checkbox
category: Selection and input
keywords:
- accept
- decline
- terms
- input
- multiple choice lists
- terms and services
- checkboxes
- check boxes
- multiple selections
- form selections
- multi-choice lists
examples:
- fileName: checkbox-default.tsx
title: Default
de... | 550 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/choice-list.mdx | ---
title: Choice list
category: Selection and input
keywords:
- ChoiceList
- form
- input
- choices
- select
- group of radio buttons
- radio button group
- group of checkboxes
- group of check boxes
- list of choices
- list of radio buttons
- list of checkboxes
- list of check boxes
- mult... | 551 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/color-picker.mdx | ---
title: Color picker
shortDescription: Allows merchants to choose a color visually, or by entering a hex value.
category: Selection and input
keywords:
- ColorPicker
- HuePicker
- AlphaPicker
- Slidable
- Choose color
- Select color
- Pick color
- color selector with transparent value
- colorpicker... | 552 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/combobox.mdx | ---
title: Combobox
category: Selection and input
keywords:
- autocomplete
- searchable
- typeahead
- combobox
- combo box
- listbox
- list box
examples:
- fileName: combobox-default.tsx
title: Default
description: Use when merchants can select one option from a predefined or editable list.
- ... | 553 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/contextual-save-bar.mdx | ---
title: Contextual save bar
shortDescription: Informs merchants of their options once they have made changes to a form on the page or while creating a new object.
category: Selection and input
keywords:
- form
- forms
- action
- actions
- save
- cancel
- logo
examples:
- fileName: contextual-save-bar... | 554 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/date-picker.mdx | ---
title: Date picker
category: Selection and input
keywords:
- DatePicker
- month
- day
- year
- weekday
- choose date
- pick date
- pick time
- date picker
- calendar
- date selector
- date range picker
- date range selector
examples:
- fileName: date-picker-default.tsx
title: Default... | 555 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/drop-zone.mdx | ---
title: Drop zone
category: Selection and input
keywords:
- upload
- image upload
- file upload
- drag
- drop
- area
- drop area
- file dialog
- upload placeholder
- drop placeholder
examples:
- fileName: drop-zone-default.tsx
title: Default
description: Use to allow merchants to upload... | 556 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/filters.mdx | ---
title: Filters
shortDescription: A composite component that filters the items of a list or table.
category: Selection and input
keywords:
- filters
- filtering
- filter control
- resource list
- index
- list filter
- table
examples:
- fileName: filters-with-a-resource-list.tsx
title: With a reso... | 557 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/form.mdx | ---
title: Form
category: Selection and input
keywords:
- form
- forms
- input
- checkbox
- check box
- textfield
- text field
- post
- get
examples:
- fileName: form-custom-on-submit.tsx
title: Custom onSubmit
description: Use onSubmit as a callback for when your form is submitted.
- file... | 558 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/index-filters.mdx | ---
title: Index filters
category: Selection and input
keywords:
- filters
- filtering
- filter control
- tabs
- index
- list filter
- table
examples:
- fileName: index-filters-default.tsx
title: Default
description: An IndexFilters component with view management, search, filtering, and sorting.... | 559 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/index.mdx | ---
title: Selection and input
expanded: true
order: 3
previewImg: /images/components/selection-and-input.png
---
# {frontmatter.title}
<Lede>
Choose or enter information using elements like checkboxes, text fields, and more.
</Lede>
<RichCardGrid cards={posts} />
| 560 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/inline-error.mdx | ---
title: Inline error
category: Selection and input
keywords:
- InlineError
- error message
- form error
- invalid input
- form group
examples:
- fileName: inline-error-default.tsx
title: Default
description: Use when the merchant has entered information that is not valid into multiple fields insi... | 561 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/radio-button.mdx | ---
title: Radio button
category: Selection and input
keywords:
- RadioButton
- selection
- choices
- options
- pick
- single selection form
- choice form
- option button
- radio button form
- toggle
- switch
examples:
- fileName: radio-button-default.tsx
title: Default
description: Use ... | 562 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/range-slider.mdx | ---
title: Range slider
category: Selection and input
keywords:
- RangeSlider
- input
- range
- slider
- percent
- number
- range form
examples:
- fileName: range-slider-default.tsx
title: Default
description: Use when a single value between `0 and 100` needs to be selected.
- fileName: range-... | 563 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/select.mdx | ---
title: Select
category: Selection and input
keywords:
- on off
- switch
- adjuster
- dropdown menu
- drop-down menu
- menu
- form
- combobox
- combo box
- choice list
- choicelist
- list
- disabled select
- field label
- long list of options
- long option list
- separate error mess... | 564 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/tag.mdx | ---
title: Tag
category: Selection and input
keywords:
- indicator
- label
- label objects
- organize objects
- categorize objects
- categories
- keywords
examples:
- fileName: tag-default.tsx
title: Default
description: Use to signify the attributes of an object.
- fileName: tag-removable.tsx... | 565 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/selection-and-input/text-field.mdx | ---
title: Text field
category: Selection and input
keywords:
- TextField
- input
- textarea
- type
- add info
- form field
- input forms
- form input
- field
- active state
- input active state
- input state
- input focus
- focus
- textbar
- text bar
- forms
- form inputs
- form t... | 566 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/tables/data-table.mdx | ---
title: Data table
shortDescription: Used to organize and display all information from a data set. Aimed to be as simple as possible for merchants.
category: Tables
keywords:
- DataTable
- data
- table
- tabular
- index
examples:
- fileName: data-table-default.tsx
title: Default
description: Use ... | 567 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/tables/index-table.mdx | ---
title: Index table
category: Tables
keywords:
- ResourceList
- index
- table
- list
- collections
- items
- objects
- list of products
- list of orders
- product lists
- order lists
- collections lists
- collection lists
- list of collections
- product listings list
- channel lists
... | 568 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/tables/index.mdx | ---
title: Tables
expanded: true
order: 7
previewImg: /images/components/tables.png
---
# {frontmatter.title}
<Lede>
Display, organize, and sort data for merchants to analyze and take action on.
</Lede>
<RichCardGrid cards={posts} />
| 569 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/typography/index.mdx | ---
title: Typography
expanded: true
order: 6
previewImg: /images/components/typography.png
---
# {frontmatter.title}
<Lede>
Establish hierarchy and communicate importance through text presentation.
</Lede>
<RichCardGrid cards={posts} />
| 570 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/typography/text.mdx | ---
title: Text
category: Typography
keywords:
- titles
- text
- typographic
- spacing
- display
- heading
- body
- success
- critical
- warning
- subdued
- regular
- medium
- semibold
- bold
- list
examples:
- fileName: text-heading.tsx
title: Heading
description: >-
Use... | 571 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/utilities/app-provider.mdx | ---
title: App provider
category: Utilities
keywords:
- app
- provider
- appprovider
- internationalization
- i18n
- localization
- context
- translate
- translation
- application wrapper
- wrapper
- sdk
examples:
- fileName: app-provider-default.tsx
title: Default
description: AppProv... | 572 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/utilities/collapsible.mdx | ---
title: Collapsible
shortDescription: Hides content and allows merchants to expand it. Used to hide optional settings, information, and actions.
category: Utilities
keywords:
- hide
- show
- low priority
- less important
- disclosure
- accordion
- accordian
- expand content
- toggle
- toggleable
... | 573 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/utilities/frame.mdx | ---
title: Frame
shortDescription: Creates the structure of the Shopify admin. All of the main sections of the admin are nested in the frame.
category: Utilities
keywords:
- navigation
- nav
- links
- primary navigation
- main navigation
- global
- frame
- sidebar
- side bar
- loading
- top bar
... | 574 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/utilities/index.mdx | ---
title: Utilities
expanded: true
order: 11
previewImg: /images/components/utilities.png
---
# {frontmatter.title}
<Lede>
Utilities are core tools for managing the structure of the admin and global settings.
</Lede>
<RichCardGrid cards={posts} />
| 575 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components | petrpan-code/Shopify/polaris/polaris.shopify.com/content/components/utilities/scrollable.mdx | ---
title: Scrollable
shortDescription: Used in components with too much content for the available vertical space. Embeds long-form content in components like modals and popovers.
category: Utilities
keywords:
- long form
- text container
- terms of service
- long form container
- scrolling
- independently ... | 576 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/actionable-language.mdx | ---
title: Actionable language
description: Merchants use Shopify to get things done. Content should be written and structured to help them understand and take the most important actions.
icon: CircleRightMajor
keywords:
- button content
- button copy
- button terminology
- writing for buttons
- link content
... | 577 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/alternative-text.mdx | ---
title: Alternative text
description: Alternative text (alt text) helps provide an inclusive experience for merchants who use screen readers.
icon: ImageAltMajor
keywords:
- speech synthesis
- alt HTML element attribute
- alt text attribute
- screen reader
- a11y
- universal design
- inclusivity
- di... | 578 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/error-messages.mdx | ---
title: Error messages
description: Error messages can be scary. Make errors visible to merchants, easy to understand, and helpful.
icon: DiamondAlertMajor
keywords:
- error states
- invalid
- 500
- 400
- 404
- error pages
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
Error messages... | 579 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/grammar-and-mechanics.mdx | ---
title: Grammar and mechanics
description: This guide is to help designers, developers, recruiters, UX-ers, product managers, support advisors, or anyone who writes public-facing text for Shopify.
icon: GrammarMajor
keywords:
- writing instructions
- writing rules
- writing guidelines
- copy instructions
-... | 580 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/help-content.mdx | ---
title: Help content
description: Help content is educational text that describes interactive elements or offers information about concepts in the UI.
icon: QuestionMarkInverseMajor
keywords:
- help text
- learn more
- help center
- help
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
The... | 581 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/help-documentation.mdx | ---
title: Help documentation
description: After you build an app or other integration, writing help documentation will show merchants how to use it.
icon: QuestionMarkInverseMajor
keywords:
- writing instructions
- writing guides
- writing tutorials
- writing how-to's
- writing how to's
- writing how to
... | 582 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/inclusive-language.mdx | ---
title: Inclusive language
description: Make commerce better for everyone by writing inclusively.
icon: AccessibilityMajor
keywords:
- copy instructions
- copy rules
- copy guidelines
- content instructions
- content rules
- word list
- language
- race
- racial
- racist
- racism
- a11y
- ac... | 583 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/index.mdx | ---
title: Content
order: 4
description: Thoughtful, consistent interface content is a core element of a well-designed user experience.
icon: TextAlignmentLeftMajor
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
<RichCardGrid cards={posts} category="content" />
| 584 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/merchant-to-customer.mdx | ---
title: Merchant-to-customer content
description: Shopify creates content for different audiences. One of those audiences is merchants’ customers. A customer is a person or organization who interacts with a Shopify merchant or a merchant’s sales channel.
icon: EmailNewsletterMajor
keywords:
- merchant to buyer
-... | 585 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/naming.mdx | ---
title: Naming
description: The names we give our products and features teach merchants how to use Shopify and how to find the things they need to run their business.
icon: ProductsMajor
keywords:
- names
- caps
- capitalizations
- capitalizing
- how to name
- naming at Shopify
- naming guidelines
- ... | 586 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/product-content.mdx | ---
title: Product content
description: Thoughtful, consistent interface content is a core element of a well-designed user experience.
icon: ColumnWithTextMajor
keywords:
- content standards
- content guidelines
- content strategy practices
- interface content
- strategic language
- edit content
- editing... | 587 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/content/voice-and-tone.mdx | ---
title: Voice and tone
description: Learn how to apply Shopify’s voice and choose the right tone, no matter what product, feature, or app you’re building.
icon: ChatMajor
keywords:
- sound like Shopify
- personality of Shopify
- brand personality
- empathy
- merchant feelings
- merchant emotions
- merc... | 588 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing/components.mdx | ---
title: Contributing to Polaris React
navTitle: Components
description: Anyone is welcome to contribute to Polaris React components. There are several types of component contributions, but they typically fall under three categories; bug fix, enhancement, or new pattern.
keywords:
- components
- contributing to p... | 589 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing/figma-ui-kit.mdx | ---
title: Contributing to the Figma UI Kit
navTitle: Figma UI Kit
keywords:
- ui kit
- figma
- how to contribute to polaris ui kit
- how to fix a figma component
order: 2
---
# {frontmatter.title}
Any designer that works at Shopify can contribute to the Figma UI Kit. If you find a bug to fix or your team is ... | 590 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing/icons.mdx | ---
title: Contributing to Polaris Icons
navTitle: Icons
keywords:
- icons
- add a new icon
- deprecate an icon
- update an icon
- how to contribute to polaris icons
order: 3
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
Icons are important visual aids that help merchants understand acti... | 591 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing/index.mdx | ---
title: Contributing to Polaris
navTitle: Contributing
description: Polaris is built for merchants, by you.
keywords:
- how to contribute to polaris
- contribution
- contribute
order: 10
newSection: true
icon: MobilePlusMajor
showTOC: true
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
Any... | 592 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing/documentation/creating-layout.mdx | ---
title: Creating layout
navTitle: Creating layout
keywords:
- how to contribute to polaris documentation
- how to contribute to the style guide
- documenting in polaris
- documentation guidelines
order: 1
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
<Subnav />
Creating layouts in pola... | 593 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing | petrpan-code/Shopify/polaris/polaris.shopify.com/content/contributing/documentation/index.mdx | ---
title: Documenting in Polaris
navTitle: Documentation
keywords:
- how to contribute to polaris documentation
- how to contribute to the style guide
- documenting in polaris
- documentation guidelines
order: 4
hideChildren: true
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
{/* <Subnav ... | 594 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/design/data-visualizations.mdx | ---
title: Data visualizations
description: Visualizations surface patterns in data, and provide immediate answers to a single, specific question.
icon: AnalyticsMajor
order: 8
keywords:
- data viz
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
<DirectiveCard status="Caution">
This section is cu... | 595 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/design/illustrations.mdx | ---
title: Illustrations
description: The Shopify admin uses a precise illustration style to help merchants quickly and clearly understand how things work across every experience.
order: 9
keywords:
- drawings
- pictures
icon: IllustrationMajor
---
![The illustration of a chair, in simples straight lines, followed... | 596 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/design/index.mdx | ---
title: Design
description: Design principles serve as guiding notions that shape the design of the Shopify admin, with Polaris providing support in implementing these principles effectively.
order: 3
status: New
icon: PaintBrushMajor
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
<RichCardGrid ... | 597 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/design/interaction-states.mdx | ---
title: Interaction states
description: Interaction states communicate the status of an element in the interface, establish confidence once an action is taken, and suggest the ability (or inability) to interact with the element.
icon: BuyButtonMajor
order: 10
keywords:
- visual patterns
- color strategy
- inte... | 598 |
0 | petrpan-code/Shopify/polaris/polaris.shopify.com/content | petrpan-code/Shopify/polaris/polaris.shopify.com/content/design/pro-design-language.mdx | ---
title: Pro design language
description: Efficiency, intuition, and style combined to empower merchants with data-rich views, action-driven interfaces, and dynamic interactions.
order: 1
icon: PaintBrushMajor
status: New
---
# {frontmatter.title}
<Lede>{frontmatter.description}</Lede>
<LayoutSection card>
<Text... | 599 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.