ScrollView

ScrollView is a container for long form content, such as order summary line items, that allows for scrolling so customers can expose more content as they view.

Basic Scrollview

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

export default reactExtension(
  'purchase.checkout.block.render',
  () => <Extension />,
);

function Extension() {
  return (
    <ScrollView maxBlockSize={300}>
      <View
        border="base"
        padding="base"
        minBlockSize={50}
      >
        View
      </View>
      <View
        border="base"
        padding="base"
        minBlockSize={50}
      >
        View
      </View>
      <View
        border="base"
        padding="base"
        minBlockSize={50}
      >
        View
      </View>
      <View
        border="base"
        padding="base"
        minBlockSize={50}
      >
        View
      </View>
      <View
        border="base"
        padding="base"
        minBlockSize={50}
      >
        View
      </View>
    </ScrollView>
  );
}

import {extension, ScrollView, View} from '@shopify/ui-extensions/checkout';

export default extension('purchase.checkout.block.render', (root) => {
  const scrollView = root.createComponent(ScrollView, {maxBlockSize: 400}, [
    root.createComponent(
      View,
      {border: 'base', padding: 'base', minBlockSize: 50},
      'View',
    ),
    root.createComponent(
      View,
      {border: 'base', padding: 'base', minBlockSize: 50},
      'View',
    ),
    root.createComponent(
      View,
      {border: 'base', padding: 'base', minBlockSize: 50},
      'View',
    ),
    root.createComponent(
      View,
      {border: 'base', padding: 'base', minBlockSize: 50},
      'View',
    ),
    root.createComponent(
      View,
      {border: 'base', padding: 'base', minBlockSize: 50},
      'View',
    ),
    root.createComponent(
      View,
      {border: 'base', padding: 'base', minBlockSize: 50},
      'View',
    ),
  ]);

  root.appendChild(scrollView);
});

ScrollViewProps

hint

Provides a hint to the user that the area is scrollable. `pill`: renders a pill with a message at the end of the the scrollable area. It disappear as soon as the user starts scrolling. `innerShadow`: renders an inner visual hint to indicate that the content is scrollable.

direction

The direction on which the content is scrollable. `block`: Indicates that the content is scrollable on the main axis. `inline`: Indicates that the content is scrollable on the cross axis.

scrollTo

Scroll to a specific position or to an element when the component is first rendered. This property allows you to set an initial scroll position or scroll to a specific element when the `ScrollView` component mounts. Note that this action will only be performed once, during the initial render of the component.

onScroll

Callback function that is called when the scroll position changes. Allows to listen to events inside the component returning the position of the scroll. Note: On touch devices, the onScroll event is fired only when the user finishes scrolling which differs from non touch devices, where the onScroll event is fired when the user scrolls

onScrolledToEdge

Callback function that is called when the scroll position reaches one of the edges.

id

A unique identifier for the component.

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`, `large200`, `small200`] means blockStart padding is `base`, inlineEnd padding is `none`, blockEnd padding is `large200` and blockStart padding is `small200`

ScrollViewEvent

position

The current scroll position, in pixels.

scrolledTo

A flag to indicate if the scroll is at the start or end of an axis.

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'

MaybeShorthandProperty

T | ShorthandProperty<T>

ShorthandProperty

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

BorderStyle

'base' | 'dotted' | 'none'

BorderWidth

'base' | 'medium'

CornerRadius

CornerRadiusDeprecated

'tight' | 'loose'

Spacing

SpacingDeprecated

'extraTight' | 'tight' | 'loose' | 'extraLoose'