# BlockStack
BlockStack is used to vertically stack elements.
### Basic BlockStack
```tsx
import {
reactExtension,
BlockStack,
View,
} from '@shopify/ui-extensions-react/checkout';
export default reactExtension(
'purchase.checkout.block.render',
() => <Extension />,
);
function Extension() {
return (
<BlockStack>
<View border="base" padding="base">
View
</View>
<View border="base" padding="base">
View
</View>
<View border="base" padding="base">
View
</View>
</BlockStack>
);
}
```
```js
import {extension, BlockStack, View} from '@shopify/ui-extensions/checkout';
export default extension('purchase.checkout.block.render', (root) => {
const blockStack = root.createComponent(BlockStack, undefined, [
root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
root.createComponent(View, {border: 'base', padding: 'base'}, 'View'),
]);
root.appendChild(blockStack);
});
```
## BlockStackProps
### BlockStackProps
### accessibilityLabel
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>`
### background
Adjust the background.
### 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`
### borderRadius
### 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`
### 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
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.
### id
A unique identifier for the component.
### inlineAlignment
Position children along the main axis
### maxBlockSize
Adjust the maximum block size.
`number`: size in pixels.
`` `${number}%` ``: size in percentages.
`fill`: takes all the available space.
See [MDN explanation of maxBlockSize](https://developer.mozilla.org/en-US/docs/Web/CSS/max-block-size).
### maxInlineSize
Adjust the maximum inline size.
`number`: size in pixels.
`` `${number}%` ``: size in percentages.
`fill`: takes all the available space.
See [MDN explanation of maxInlineSize](https://developer.mozilla.org/en-US/docs/Web/CSS/max-inline-size).
### minBlockSize
Adjust the block size.
`number`: size in pixels.
`` `${number}%` ``: size in percentages.
`fill`: takes all the available space.
See [MDN explanation of minBlockSize](https://developer.mozilla.org/en-US/docs/Web/CSS/min-block-size).
### minInlineSize
Adjust the minimum inline size.
`number`: size in pixels.
`` `${number}%` ``: size in percentages.
`fill`: takes all the available space.\
See [MDN explanation of minInlineSize](https://developer.mozilla.org/en-US/docs/Web/CSS/min-inline-size).
### overflow
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
Adjust spacing between children
### ViewLikeAccessibilityRole
NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]
### NonPresentationalAccessibilityRole
'main' | 'header' | 'footer' | 'section' | 'complementary' | 'navigation' | 'orderedList' | 'listItem' | 'unorderedList' | 'separator' | 'status' | 'alert'
### MaybeConditionalStyle
A type that represents a value that can be a conditional style. We highly recommend using the `Style` helper which simplifies the creation of conditional styles.
To learn more check out the [conditional styles](/api/checkout-ui-extensions/components/utilities/stylehelper) documentation.
T | ConditionalStyle<T, AcceptedConditions>
### ConditionalStyle
### conditionals
An array of conditional values.
### default
The default value applied when none of the conditional values specified in `conditionals` are met.
### ConditionalValue
### conditions
The conditions that must be met for the value to be applied. At least one condition must be specified.
### value
The value that will be applied if the conditions are met.
### Background
'transparent' | 'base' | 'subdued'
### MaybeResponsiveConditionalStyle
A type that represents a value that can be a conditional style. The conditions are based on the viewport size. We highly recommend using the `Style` helper which simplifies the creation of conditional styles.
To learn more check out the [conditional styles](/api/checkout-ui-extensions/components/utilities/stylehelper) documentation.
T | ConditionalStyle<T, ViewportSizeCondition>
### ViewportSizeCondition
### viewportInlineSize
### MaybeShorthandProperty
T | ShorthandProperty<T>
### ShorthandProperty
[T, T] | [T, T, T, T]
### BorderStyle
'base' | 'dashed' | 'dotted' | 'none'
### CornerRadius
'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated
### CornerRadiusDeprecated
'tight' | 'loose'
### BorderWidth
'base' | 'medium' | 'thick'
### InlineAlignment
'start' | 'center' | 'end'
### Spacing
'none' | 'extraTight' | 'tight' | 'base' | 'loose' | 'extraLoose'
## Related
- [StyleHelper](/docs/api/checkout-ui-extensions/unstable/components/utilities/stylehelper)
## Examples
BlockStack is used to vertically stack elements.
###
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.
### Strategies for simplifying layout and aligning content using Disclosure and Inline/Block Layout components.
```jsx
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"
>
<BlockStack spacing="none">
<Disclosure
defaultOpen="one"
onToggle={(open) =>
console.log('onToggle event', open)
}
>
<Pressable toggles="one" padding="base">
<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',
'base',
'base',
]}
>
<Form
onSubmit={() =>
console.log('onSubmit event')
}
>
<BlockStack>
<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>
<Divider />
<InlineLayout
blockAlignment="baseline"
spacing="base"
columns={['auto', 'fill', 'auto']}
padding="base"
>
<Icon
source="profile"
appearance="subdued"
/>
<BlockStack spacing="none">
<InlineStack blockAlignment="center">
<Text>Verify with</Text>
<Image source="https://via.placeholder.com/50x15" />
</InlineStack>
<Text
appearance="subdued"
size="small"
>
15% savings for students and
military
</Text>
</BlockStack>
<Pressable to="https://www.shopify.com">
<Icon
source="external"
appearance="subdued"
/>
</Pressable>
</InlineLayout>
</BlockStack>
</View>
);
};
```
```js
import {
extension,
BlockStack,
View,
InlineLayout,
InlineStack,
Image,
Pressable,
Icon,
Text,
TextField,
Form,
Button,
Disclosure,
Divider,
} from '@shopify/ui-extensions/checkout';
export default extension(
'purchase.checkout.block.render',
(root) => {
const openIds = ['one'];
const pressable = root.createComponent(
Pressable,
{
toggles: 'one',
padding: 'base',
},
[
root.createComponent(
InlineLayout,
{
blockAlignment: 'center',
spacing: 'base',
columns: ['auto', 'fill', 'auto'],
},
[
root.createComponent(Icon, {
source: 'gift',
appearance: 'subdued',
}),
'Gift message',
root.createComponent(Icon, {
source: openIds.includes('one')
? 'chevronUp'
: 'chevronDown',
size: 'small',
}),
],
),
],
);
const disclosureView = root.createComponent(
View,
{
id: 'one',
padding: ['none', 'base', 'base', 'base'],
},
[
root.createComponent(
Form,
{
onSubmit: () =>
console.log('onSubmit event'),
},
[
root.createComponent(BlockStack, {}, [
root.createComponent(
InlineLayout,
{
columns: ['fill', 'fill'],
spacing: 'base',
},
[
root.createComponent(
TextField,
{
label: 'From',
name: 'from0',
id: 'from0',
},
),
root.createComponent(
TextField,
{
label: 'To',
name: 'to0',
id: 'to0',
},
),
],
),
root.createComponent(TextField, {
label: 'Message',
name: 'message0',
id: 'message0',
}),
root.createComponent(View, {}, [
root.createComponent(
Button,
{
accessibilityRole: 'submit',
kind: 'secondary',
},
'Save',
),
]),
]),
],
),
],
);
const disclosure = root.createComponent(
Disclosure,
{
defaultOpen: 'one',
onToggle: (open) =>
console.log('onToggle event', open),
},
[pressable, disclosureView],
);
const inlineLayout = root.createComponent(
InlineLayout,
{
blockAlignment: 'baseline',
spacing: 'base',
columns: ['auto', 'fill', 'auto'],
padding: 'base',
},
[
root.createComponent(Icon, {
source: 'profile',
appearance: 'subdued',
}),
root.createComponent(
BlockStack,
{
spacing: 'none',
},
[
root.createComponent(
InlineStack,
{
blockAlignment: 'center',
},
[
root.createComponent(
Text,
{},
'Verify with',
),
root.createComponent(Image, {
source:
'https://via.placeholder.com/50x15',
}),
],
),
root.createComponent(
Text,
{
appearance: 'subdued',
size: 'small',
},
'15% savings for students and military',
),
],
),
root.createComponent(
Pressable,
{
to: 'https://www.shopify.com',
},
[
root.createComponent(Icon, {
source: 'external',
appearance: 'subdued',
}),
],
),
],
);
const view = root.createComponent(
View,
{
maxInlineSize: 400,
cornerRadius: 'large',
border: 'base',
},
[
root.createComponent(
BlockStack,
{
spacing: 'none',
},
[
disclosure,
root.createComponent(Divider),
inlineLayout,
],
),
],
);
root.appendChild(view);
},
);
```