import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
const data: ReferenceEntityTemplateSchema = {
name: 'BlockLayout',
description:
'BlockLayout is used to lay out content over multiple rows.\n\nBy default, all rows fill the available block space, sharing it equally.',
thumbnail: 'blocklayout-thumbnail.png',
isVisualComponent: true,
requires: '',
type: '',
definitions: [
{
title: 'BlockLayoutProps',
description: '',
type: 'BlockLayoutProps',
},
],
category: 'Components',
subCategory: 'Structure',
defaultExample: {
image: 'blocklayout-default.png',
codeblock: {
title: 'Basic BlockLayout',
tabs: [
{
title: 'React',
code: '../../../../checkout-ui-extensions-react/src/components/BlockLayout/examples/basic-blocklayout.example.tsx',
language: 'tsx',
},
{
title: 'JS',
code: './examples/basic-blocklayout.example.ts',
language: 'js',
},
],
},
},
subSections: [
{
type: 'Generic',
anchorLink: 'accessibility-roles',
title: 'Accessibility roles',
sectionContent:
'| Value | Description |\n| --- | --- |\n| "main" | Used to indicate the primary content. |\n| "header" | Used to indicate the component is a header. |\n| "footer" | Used to display information such as copyright information, navigation links, and privacy statements. |\n| "section" | Used to indicate a generic section. |\n| "complementary" | Used to designate a supporting section that relates to the main content. |\n| "navigation" | Used to identify major groups of links used for navigating. |\n| "orderedList" | Used to identify a list of ordered items. |\n| "listItem" | Used to identify an item inside a list of items. |\n| "unorderedList" | Used to identify a list of unordered items. |\n| "separator" | Used to indicates the component acts as a divider that separates and distinguishes sections of content. |\n| "status" | Used to define a live region containing advisory information for the user that is not important enough to be an alert. |\n| "alert" | Used for important, and usually time-sensitive, information. |',
},
],
related: [],
};
export default data;