BlockStack

BlockStack is used to vertically stack elements.

import {render, BlockStack, View} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => );

function Extension() {
  return (
    
      
        View
      
      
        View
      
      
        View
      
    
  );
}

import {extend, BlockStack, View} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::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

inlineAlignment

Position children along the main axis

spacing

Adjust spacing between children

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>`

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.

id

A unique identifier for the component.

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.

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`

borderRadius

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.

maxBlockSize

Adjust the maximum block size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.

maxInlineSize

Adjust the maximum inline size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.

minInlineSize

Adjust the minimum inline size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.

minBlockSize

Adjust the block size. `number`: size in pixels. `` `${number}%` ``: size in percentages. `fill`: takes all the available space.

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`

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>

ConditionalStyle

default

The default value applied when none of the conditional values specified in `conditionals` are met.

conditionals

An array of conditional values.

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.

ViewportSizeCondition

viewportInlineSize

ViewportInlineSize

'small' | 'medium' | 'large'

InlineAlignment

'start' | 'center' | 'end'

Spacing

'none' | 'base' | 'extraTight' | 'tight' | 'loose' | 'extraLoose'

ViewLikeAccessibilityRole

NonPresentationalAccessibilityRole | [NonPresentationalAccessibilityRole, NonPresentationalAccessibilityRole]

NonPresentationalAccessibilityRole

'main' | 'header' | 'footer' | 'section' | 'complementary' | 'navigation' | 'orderedList' | 'listItem' | 'unorderedList' | 'separator' | 'status' | 'alert'

MaybeShorthandProperty

T | ShorthandProperty<T>

ShorthandProperty

[T, T] | [T, T, T, T]

BorderStyle

'base' | 'dotted' | 'none'

BorderWidth

'base' | 'medium'

CornerRadius

'base' | 'small' | 'large' | 'fullyRounded' | 'none' | CornerRadiusDeprecated

CornerRadiusDeprecated

'tight' | 'loose'

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.

import React from 'react';
import {
  render,
  View,
  Image,
  Icon,
  Pressable,
  Disclosure,
  InlineLayout,
  BlockStack,
  Text,
  Form,
  TextField,
  Button,
  Divider,
  InlineStack,
} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => (
  
));

export const DisclosureAndAlignment = () => {
  const openIds = ['one'];
  return (
    
      
        
            console.log('onToggle event', open)
          }
        >
          
            
              
              Gift message
              
            
          
          
            

                console.log('onSubmit event')
              }
            >
              
                
                  
                  
                
                
                
                  
                    Save
                  
                
              
            
          
        
        
        
          
          
            
              Verify with
              
            
            
              15% savings for students and
              military
            
          
          
            
          
        
      
    
  );
};

import {
  extend,
  BlockStack,
  View,
  InlineLayout,
  InlineStack,
  Image,
  Pressable,
  Icon,
  Text,
  TextField,
  Form,
  Button,
  Disclosure,
  Divider,
} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::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);
});

import React from 'react';
import {
  render,
  View,
  Image,
  Icon,
  Pressable,
  Disclosure,
  InlineLayout,
  BlockStack,
  Text,
  Form,
  TextField,
  Button,
  Divider,
  InlineStack,
} from '@shopify/checkout-ui-extensions-react';

render('Checkout::Dynamic::Render', () => (
  
));

export const DisclosureAndAlignment = () => {
  const openIds = ['one'];
  return (
    
      
        
            console.log('onToggle event', open)
          }
        >
          
            
              
              Gift message
              
            
          
          
            

                console.log('onSubmit event')
              }
            >
              
                
                  
                  
                
                
                
                  
                    Save
                  
                
              
            
          
        
        
        
          
          
            
              Verify with
              
            
            
              15% savings for students and
              military
            
          
          
            
          
        
      
    
  );
};

import {
  extend,
  BlockStack,
  View,
  InlineLayout,
  InlineStack,
  Image,
  Pressable,
  Icon,
  Text,
  TextField,
  Form,
  Button,
  Disclosure,
  Divider,
} from '@shopify/checkout-ui-extensions';

extend('Checkout::Dynamic::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);
});