Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/giant-scissors-smoke.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'polaris.shopify.com': minor
---

Patterns documentation is now written in Markdown to match all other site content.
8 changes: 0 additions & 8 deletions polaris.shopify.com/content/patterns/app-settings-layout.md

This file was deleted.

97 changes: 0 additions & 97 deletions polaris.shopify.com/content/patterns/app-settings-layout.ts

This file was deleted.

23 changes: 23 additions & 0 deletions polaris.shopify.com/content/patterns/app-settings-layout/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: App settings layout
description: Scan and find groups of settings in apps
lede: Lets merchants scan and find groups of settings in apps.
url: /patterns/app-settings-layout
previewImg: /images/patterns/pattern-thumbnail-app-settings.png
githubDiscussionsLink: https://github.com/Shopify/polaris/discussions/8217
variants:
- 'variants/default.md'
---

<div as="Variants"></div>

<div as="Stack" gap="4">

## Related resources

* See another two-column layout in use in the [Resource detail layout](/patterns/resource-details-layout) pattern.
* See a single-column layout in use in the [Resource index layout](/patterns/resource-index-layout) pattern.
* Learn more about [Layout](https://shopify.dev/apps/design-guidelines/layout) in the app design guidelines.
* Check out the Polaris [Spacing](/design/space) guidelines to understand Polaris grid and spacing scale.

</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---

hideFromNav: true
---


<div as="HowItHelps">

## How it helps merchants

![App settings page with two columns](/images/patterns/app-settings-cover-image.png)

1. In the left column, glanceable labels and descriptions are listed to make it easier for merchants to scan the page and quickly find what they are looking for.
2. In the right column, settings are grouped in cards to make it easier for merchants to configure a setting after it's been found, or to configure multiple settings that might belong together.

<div as="DefinitionTable">

### Use when merchants need to:

**Find and change app settings**
: This pattern is used specifically for finding and updating individual app settings within the Shopify admin.

</div>
</div>
<div as="Usage">

## Using this pattern

This pattern uses the [`AlphaStack`](/components/layout-and-structure/alpha-stack), [`AlphaCard`](/components/layout-and-structure/alpha-card), [`Columns`](/components/layout-and-structure/columns) and [`Box`](/components/layout-and-structure/box) components.

<!-- prettier-ignore -->
```javascript {"type":"previewContext","for":"example"}
<div style={{ paddingBottom: '2rem' }}>
____CODE____
</div>
```

```javascript {"type":"livePreview","id":"example"}
<Page
divider
primaryAction={{ content: "View on your store", disabled: true }}
secondaryActions={[
{
content: "Duplicate",
accessibilityLabel: "Secondary action label",
onAction: () => alert("Duplicate action"),
},
]}
>
<AlphaStack gap="16" align="center">
<Columns columns={{ xs: "1fr", md: "2fr 5fr" }}>
<Box as="section" paddingInlineStart={{ xs: 4, sm: 0 }} paddingInlineEnd={{ xs: 2, sm: 0 }}>
<AlphaStack gap="4">
<Text as="h3" variant="headingMd">
InterJambs
</Text>
<Text as="p" variant="bodyMd">
Interjambs are the rounded protruding bits of your puzzlie piece
</Text>
</AlphaStack>
</Box>
<AlphaCard roundedAbove="sm">
<AlphaStack gap="4" fullWidth>
<TextField label="Interjamb style" />
<TextField label="Interjamb ratio" />
</AlphaStack>
</AlphaCard>
</Columns>
<Columns columns={{ xs: "1fr", md: "2fr 5fr" }}>
<Box as="section" paddingInlineStart={{ xs: 2, sm: 0 }} paddingInlineEnd={{ xs: 2, sm: 0 }}>
<AlphaStack gap="4">
<Text as="h3" variant="headingMd">
Dimensions
</Text>
<Text as="p" variant="bodyMd">
Interjambs are the rounded protruding bits of your puzzlie piece
</Text>
</AlphaStack>
</Box>
<AlphaCard roundedAbove="sm">
<AlphaStack gap="4" fullWidth>
<TextField label="Horizontal" />
<TextField label="Interjamb ratio" />
</AlphaStack>
</AlphaCard>
</Columns>
</AlphaStack>
</Page>
```

</div>
<div as="UsefulToKnow">

### Useful to know

| | |
|-|-|
|Don't include a description unless it's helpful.|![Section header with no description on an app settings page](/images/patterns/app-settings-usage-1.png)|
|Place grouped settings within cards.|![App settings page with section headings and grouped settings](/images/patterns/app-settings-usage-2.png)|
|Stack all setting groups vertically on the page.|![App settings page with two vertically stacked sections](/images/patterns/app-settings-usage-3.png)|

</div>
8 changes: 0 additions & 8 deletions polaris.shopify.com/content/patterns/date-picking.md

This file was deleted.

Loading