Skip to content

Commit 31a1172

Browse files
authored
Checkout: update docs for components.
2 parents f4711f6 + f0dc912 commit 31a1172

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+392
-267
lines changed
2.78 KB
Loading
12.2 KB
Loading
Binary file not shown.
Binary file not shown.

packages/ui-extensions/src/docs/shared/components/Abbreviation.ts

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,26 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
22

33
const data: SharedReferenceEntityTemplateSchema = {
44
name: 'Abbreviation',
5-
description:
6-
'A text that represents an abbreviation or acronym. Abbreviation has an inline layout. Surfaces may apply styling to this component.',
5+
description: 'A text that represents an abbreviation or acronym.',
76
category: 'Polaris web components',
87
subCategory: 'Titles and text',
8+
related: [
9+
{
10+
name: 'Text',
11+
url: 'text',
12+
type: 'Component',
13+
},
14+
{
15+
name: 'Paragraph',
16+
url: 'paragraph',
17+
type: 'Component',
18+
},
19+
{
20+
name: 'Time',
21+
url: 'time',
22+
type: 'Component',
23+
},
24+
],
925
};
1026

1127
export default data;

packages/ui-extensions/src/docs/shared/components/Banner.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ const data: SharedReferenceEntityTemplateSchema = {
66
'Use `s-banner` to communicate important status updates or indicate that there are important actions that users must take. \n\n You can use banners both as a standalone component on a page or inside of a `s-section`.',
77
category: 'Polaris web components',
88
subCategory: 'Feedback',
9+
related: [],
910
};
1011

1112
export default data;

packages/ui-extensions/src/docs/shared/components/Box.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ const data: SharedReferenceEntityTemplateSchema = {
66
'The `s-box` component is an escape hatch for building custom user interfaces. You should only use `s-box` when you cannot build what you need with the existing components.',
77
category: 'Polaris web components',
88
subCategory: 'Structure',
9+
related: [],
910
};
1011

1112
export default data;

packages/ui-extensions/src/docs/shared/components/Button.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ const data: SharedReferenceEntityTemplateSchema = {
66
'Use `s-button` when you want to provide users the ability to perform specific actions, submitting forms, or opening dialogs.',
77
category: 'Polaris web components',
88
subCategory: 'Actions',
9+
related: [
10+
{
11+
name: 'Link',
12+
url: 'link',
13+
type: 'Component',
14+
},
15+
],
916
};
1017

1118
export default data;

packages/ui-extensions/src/docs/shared/components/ClipboardItem.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,18 @@ const data: SharedReferenceEntityTemplateSchema = {
1111
`,
1212
category: 'Polaris web components',
1313
subCategory: 'utilities',
14+
related: [
15+
{
16+
name: 'Button',
17+
url: 'button',
18+
type: 'Component',
19+
},
20+
{
21+
name: 'Link',
22+
url: 'link',
23+
type: 'Component',
24+
},
25+
],
1426
};
1527

1628
export default data;

packages/ui-extensions/src/docs/shared/components/DropZone.ts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
22

33
const data: SharedReferenceEntityTemplateSchema = {
44
name: 'DropZone',
5-
description: `DropZone allows file uploads through drag-and-drop functionality into a designated area on a page, or by activating a button. At present, DropZone does not offer image upload preview capabilities. The use of object URLs directly in an image component is not possible due to the extension and host operating on separate domains.
6-
\n Any element focused within the Dropzone component, including child elements such as the 'Add file' button, will initiate the file selector when the Enter or Spacebar key is pressed.
5+
description: `
6+
\`s-drop-zone\` allows file uploads through drag-and-drop functionality into a designated area on a page, or by activating a button. At present, \`s-drop-zone\` does not offer image upload preview capabilities. The use of object URLs directly in an image component is not possible due to the extension and host operating on separate domains.
7+
8+
Any element focused within the \`s-drop-zone\` component, including child elements such as the 'Add file' button, will initiate the file selector when the Enter or Spacebar key is pressed.
79
`,
810
category: 'Polaris web components',
911
subCategory: 'Forms',
12+
related: [],
1013
};
1114

1215
export default data;

0 commit comments

Comments
 (0)