Choose a version:

InlineLayout

InlineLayout is used to lay out content over multiple columns.

By default, all columns are of equal size and fill the available inline space. Content does not wrap on new rows when not enough columns have been explicitly set, instead they are added as new column and fill the remaining inline space.

Anchor to inlinelayoutpropsInlineLayoutProps

accessibilityLabel

string

A label that describes the purpose or contents of the element. When set, it will be announced to buyers using assistive technologies and will provide them with more context.

accessibilityRole

Sets the semantic meaning of the component’s content. When set, the role will be used by assistive technologies to help buyers navigate the page.

For example:

In an HTML host a ['listItem', 'separator'] tuple will render: <li role='separator'>
In an HTML host a listItem string will render: <li>

blockAlignment

Position children along the cross axis.

border

<<>>

Adjust the border style.

To shorten the code, it is possible to specify all the border style properties in one property.

For example:

base means blockStart, inlineEnd, blockEnd and inlineStart border styles are base
['base', 'none'] means blockStart and blockEnd border styles are base, inlineStart and inlineEnd border styles are none
['base', 'none', 'dotted', 'base'] means blockStart border style is base, inlineEnd border style is none, blockEnd border style is dotted and blockStart border style is base

borderWidth

< <> >

Adjust the border width.

To shorten the code, it is possible to specify all the border width properties in one property.

For example:

base means blockStart, inlineEnd, blockEnd and inlineStart border widths are base
['base', 'medium'] means blockStart and blockEnd border widths are base, inlineStart and inlineEnd border widths are medium
['base', 'medium', 'medium', 'base'] means blockStart border width is base, inlineEnd border width is medium, blockEnd border width is medium and blockStart border width is base

columns

Default: 'fill'

Sizes for each column of the layout.

auto: intrinsic size of the element.

fill: fills the remaining available space. When multiple elements are set to fill, the remaining space is shared equally.

`${number}%`: size in percentages.

`${number}fr`: size in fractions.

number: size in pixels.

When the sum of the defined sizes is larger than the available space, elements will shrink to avoid overflow.
When the size of an element is not explicitly set, it will fill the remaining space available.
When only one size is set and outside of an array, all elements of the layout will take that size.

cornerRadius

< <> >

Adjust the corner radius.

Provide a single value to apply the same corner radius to all four corners, two values to apply different corner radii to opposing corners, or four values to apply different corner radii to each individual corner.

For example:

base means all 4 corner radii are base
['base', 'none'] means the StartStart and EndEnd corner radii are base, StartEnd and EndStart corner radii are none. When the context’s language direction is left to right, StartStart and EndEnd corners are the top left and bottom right corners while StartEnd and EndStart corners are the top right and bottom left corners.
['base', 'none', 'small', 'base'] means StartStart corner radius is base, StartEnd corner radius is none, EndEnd corner radius is small and EndStart corner radius is base

A borderRadius alias is available for this property. When both are specified, cornerRadius takes precedence.

display

<'auto' | 'none'>

Default: 'auto'

Changes the display of the component.

auto the component's initial value. The actual value depends on the component and context.

none hides the component and removes it from the accessibility tree, making it invisible to screen readers.

string

A unique identifier for the component.

inlineAlignment

Position children along the main axis.

maxBlockSize

< number | `${number}%` | 'fill' >

Adjust the maximum block size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.

See MDN explanation of maxBlockSize.

maxInlineSize

< number | `${number}%` | 'fill' >

Adjust the maximum inline size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.

See MDN explanation of maxInlineSize.

minBlockSize

< number | `${number}%` | 'fill' >

Adjust the block size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.

See MDN explanation of minBlockSize.

minInlineSize

< number | `${number}%` | 'fill' >

Adjust the minimum inline size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.\

See MDN explanation of minInlineSize.

overflow

'hidden' | 'visible'

Default: 'visible'

Sets the overflow behavior of the element.

hidden: clips the content when it is larger than the element’s container. The element will not be scrollable and the users will not be able to access the clipped content by dragging or using a scroll wheel.

visible: the content that extends beyond the element’s container is visible.

padding

<<>>

Adjust the padding.

To shorten the code, it is possible to specify all the padding properties in one property.

Examples:

base means blockStart, inlineEnd, blockEnd and inlineStart paddings are base
[base, none] means blockStart and blockEnd paddings are base, inlineStart and inlineEnd paddings are none
[base, none, loose, tight] means blockStart padding is base, inlineEnd padding is none, blockEnd padding is loose and blockStart padding is tight

spacing

< | [, ]>

Default: 'none'

Adjust spacing between children.

base means the space between rows and columns is base.
[base, none] means the space between rows is base, space between columns is none.

Was this section helpful?

Basic InlineLayout

import {

reactExtension,

InlineLayout,

View,

} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(

'purchase.checkout.block.render',

() => <Extension />,

);

function Extension() {

return (

20%

</View>

fill

</View>

</InlineLayout>

);

}

Preview

Anchor to accessibility-rolesAccessibility roles

Value	Description
`"main"`	Used to indicate the primary content.
`"header"`	Used to indicate the component is a header.
`"footer"`	Used to display information such as copyright information, navigation links, and privacy statements.
`"section"`	Used to indicate a generic section.
`"complementary"`	Used to designate a supporting section that relates to the main content.
`"navigation"`	Used to identify major groups of links used for navigating.
`"orderedList"`	Used to identify a list of ordered items.
`"listItem"`	Used to identify an item inside a list of items.
`"unorderedList"`	Used to identify a list of unordered items.
`"separator"`	Used to indicates the component acts as a divider that separates and distinguishes sections of content.
`"status"`	Used to define a live region containing advisory information for the user that is not important enough to be an alert.
`"alert"`	Used for important, and usually time-sensitive, information.

Was this section helpful?

Anchor to examplesExamples

Strategies for simplifying layout and aligning content using Disclosure and Inline/Block Layout components.

Use the Disclosure component to simplify the user experience and reveal interfaces only when the customer requests it. It also demonstrates how a combination of inline and block layout components can improve the readability of information. By employing these strategies, users can easily scan and comprehend the content, making for a better user experience overall.

Was this section helpful?

Strategies for simplifying layout and aligning content using Disclosure and Inline/Block Layout components.

import {

reactExtension,

View,

Image,

Icon,

Pressable,

Disclosure,

InlineLayout,

BlockStack,

Text,

Form,

TextField,

Button,

Divider,

InlineStack,

} from '@shopify/ui-extensions-react/checkout';

export default reactExtension(

'purchase.checkout.block.render',

() => <DisclosureAndAlignment />,

);

export const DisclosureAndAlignment = () => {

const openIds = ['one'];

return (

<View

maxInlineSize={400}

cornerRadius="large"

border="base"

<Disclosure

defaultOpen="one"

onToggle={(open) =>

console.log('onToggle event', open)

}

<InlineLayout

blockAlignment="center"

spacing="base"

columns={['auto', 'fill', 'auto']}

<Icon

source="gift"

appearance="subdued"

Gift message

<Icon

source={

openIds.includes('one')

? 'chevronUp'

: 'chevronDown'

}

appearance="subdued"

</InlineLayout>

</Pressable>

<View

id="one"

padding={[

'none',

'base',

]}

<Form

onSubmit={() =>

console.log('onSubmit event')

}

<InlineLayout

columns={['fill', 'fill']}

spacing="base"

<TextField

label="From"

name="from0"

id="from0"

<TextField

label="To"

name="to0"

id="to0"

</InlineLayout>

<TextField

label="Message"

name="message0"

id="message0"

<View>

<Button

accessibilityRole="submit"

kind="secondary"

Save

</Button>

</View>

</BlockStack>

</Form>

</View>

</Disclosure>

<InlineLayout

blockAlignment="baseline"

spacing="base"

columns={['auto', 'fill', 'auto']}

padding="base"

<Icon

source="profile"

appearance="subdued"

<Text>Verify with</Text>

</InlineStack>

<Text

appearance="subdued"

size="small"

15% savings for students and

military

</Text>

</BlockStack>

<Icon

source="external"

appearance="subdued"

</Pressable>

</InlineLayout>

</BlockStack>

</View>

);

};

Preview

Anchor to relatedRelated

UtilityStyleHelper