Inline
InlineSpacer is used to create empty inline space, typically when variable spacing is needed between multiple elements.
Note that you should favor InlineStack when spacing between all elements is the same.
Anchor to inlinespacerpropsInlineSpacerProps
- Anchor to spacingspacing<Exclude<, 'none'>>Default: 'base'
Adjust size of the spacer
- string
A unique identifier for the component.
InlineSpacerProps
- spacing
Adjust size of the spacer
MaybeResponsiveConditionalStyle<Exclude<Spacing, 'none'>> - id
A unique identifier for the component.
string
export interface InlineSpacerProps extends IdProps {
/**
* Adjust size of the spacer
*
* @defaultValue 'base'
**/
spacing?: MaybeResponsiveConditionalStyle<Exclude<Spacing, 'none'>>;
}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.
T - conditionals
An array of conditional values.
ConditionalValue<T, AcceptedConditions>[]
export interface ConditionalStyle<
T,
AcceptedConditions extends BaseConditions = Conditions,
> {
/**
* The default value applied when none of the conditional values
* specified in `conditionals` are met.
*/
default?: T;
/**
* An array of conditional values.
*/
conditionals: ConditionalValue<T, AcceptedConditions>[];
}ConditionalValue
- conditions
The conditions that must be met for the value to be applied. At least one condition must be specified.
AcceptedConditions - value
The value that will be applied if the conditions are met.
T
export interface ConditionalValue<
T,
AcceptedConditions extends BaseConditions = Conditions,
> {
/**
* The conditions that must be met for the value to be applied. At least one
* condition must be specified.
*/
conditions: AcceptedConditions;
/**
* The value that will be applied if the conditions are met.
*/
value: T;
}ViewportSizeCondition
- viewportInlineSize
{ min: ViewportInlineSize; }
export interface ViewportSizeCondition {
viewportInlineSize: {min: ViewportInlineSize};
}ViewportInlineSize
'small' | 'medium' | 'large'Spacing
'none' | 'base' | 'extraTight' | 'tight' | 'loose' | 'extraLoose'Basic InlineSpacer
examples
Basic InlineSpacer
React
import { render, InlineSpacer, InlineStack, View, } from '@shopify/checkout-ui-extensions-react'; render('Checkout::Dynamic::Render', () => <Extension />); function Extension() { return ( <InlineStack spacing="none"> <View border="base" padding="base"> View </View> <InlineSpacer spacing="loose" /> <View border="base" padding="base"> View </View> <InlineSpacer spacing="tight" /> <View border="base" padding="base"> View </View> <InlineSpacer spacing="base" /> <View border="base" padding="base"> View </View> </InlineStack> ); }JS
import { extend, InlineSpacer, InlineStack, View, } from '@shopify/checkout-ui-extensions'; extend('Checkout::Dynamic::Render', (root) => { const inlineSpacer = root.createComponent(InlineStack, {spacing: 'none'}, [ root.createComponent(View, {border: 'base', padding: 'base'}, 'View'), root.createComponent(InlineSpacer, {spacing: 'loose'}), root.createComponent(View, {border: 'base', padding: 'base'}, 'View'), root.createComponent(InlineSpacer, {spacing: 'tight'}), root.createComponent(View, {border: 'base', padding: 'base'}, 'View'), root.createComponent(InlineSpacer, {spacing: 'base'}), root.createComponent(View, {border: 'base', padding: 'base'}, 'View'), ]); root.appendChild(inlineSpacer); });
Preview
