Skip to content

Commit

Permalink
add docs for pos ui extension SectionHeader component
Browse files Browse the repository at this point in the history
  • Loading branch information
arigny committed Jun 21, 2024
1 parent 887e104 commit 6610942
Show file tree
Hide file tree
Showing 9 changed files with 119 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ const data: ReferenceEntityTemplateSchema = {
],
category: 'Components',
related: [],
thumbnail: 'section-header-thumbnail.png',
thumbnail: 'section-thumbnail.png',
defaultExample: {
image: 'section-header-default.png',
image: 'section-default.png',
codeblock: generateCodeBlockForComponent('Section', 'default.example'),
},
};
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
import {generateCodeBlock} from '../helpers/generateCodeBlock';

const data: ReferenceEntityTemplateSchema = {
name: 'SectionHeader',
description:
'A heading style text component with an optional divider line to structure content.',
isVisualComponent: true,
type: 'component',
definitions: [
{
title: 'SectionHeader',
description: '',
type: 'SectionHeaderProps',
},
],
category: 'Components',
related: [],
thumbnail: 'section-header-thumbnail.png',
defaultExample: {
image: 'section-header-default.png',
codeblock: generateCodeBlock(
'SectionHeader',
'section-header',
'default.example',
),
},
};

export default data;
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import {
extension,
Screen,
ScrollView,
Stack,
Navigator,
SectionHeader,
} from '@shopify/ui-extensions/point-of-sale';

export default extension(
'pos.home.modal.render',
(root, api) => {
const screen = root.createComponent(Screen, {
name: 'SectionHeader',
title: 'SectionHeader',
});

const scrollView =
root.createComponent(ScrollView);

const defaultSectionHeader = root.createComponent(
SectionHeader,
{
title: 'Default',
},
);

const actionSectionHeader =
root.createComponent(SectionHeader, {
title: 'With action',
action: {
label: 'Show toast',
onPress: () =>
api.toast.show('Hello world!'),
},
});

const noDividerSectionHeader =
root.createComponent(SectionHeader, {
title: 'Without divider',
hideDivider: true,
});

const rootStack = root.createComponent(
Stack,
{
paddingHorizontal: 'HalfPoint',
direction: 'vertical',
},
);
rootStack.append(defaultSectionHeader);
rootStack.append(actionSectionHeader);
rootStack.append(noDividerSectionHeader);

scrollView.append(rootStack);
screen.append(scrollView);
const navigator =
root.createComponent(Navigator);
navigator.append(screen);
root.append(navigator);
},
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import React from 'react'
import { Navigator, Screen, ScrollView, Stack, reactExtension, useApi, SectionHeader } from '@shopify/ui-extensions-react/point-of-sale'

const ModalComponent = () => {
const api = useApi<'pos.home.modal.render'>();

return (
<Navigator>
<Screen title="SectionHeader" name="SectionHeader">
<ScrollView>
<Stack direction="vertical" paddingHorizontal="HalfPoint">
<SectionHeader title='Default' />
<SectionHeader title='With action' action={{label: 'Action', onPress: () => { }}} />
<SectionHeader title='Without divider' hideDivider />
</Stack>
</ScrollView>
</Screen>
</Navigator>
)
}

export default reactExtension('pos.home.modal.render', () => {
return <ModalComponent />
})
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.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ const data: LandingTemplateSchema = {
### Features
- Introduced a [SectionHeader component](/docs/api/pos-ui-extensions/components/sectionheader). It can be used to title sections and structure content.
- Removed \`subtitle\` property to the [FormattedTextField](/docs/api/pos-ui-extensions/apis/formatted-text-field) component.
- Removed \`subtitle\` property to the [TextField](/docs/api/pos-ui-extensions/apis/text-field) component.
- Renamed the \`OrderAPIContent\` interface to \`OrderApiContent\`.
Expand Down

0 comments on commit 6610942

Please sign in to comment.