Skip to main content
Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.

ScrollView

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

Support
Targets (50)

Supported targets

Anchor to ScrollViewPropsScrollViewProps

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.

Anchor to accessibilityLabel
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.

Anchor to background
background
<>
Default: 'transparent'

The background color of the element, set using a design-system keyword.

  • transparent: No background; the parent's background shows through.
  • base: The standard surface background color.
  • subdued: A muted background for de-emphasized or secondary content.
Anchor to border
border
<<>>

The border style of the element.

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

Anchor to borderWidth
borderWidth
< <> >

The border width of the element.

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

Anchor to cornerRadius
cornerRadius
< <> >

The corner radius of the element.

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.

Anchor to direction
direction
'block' | 'inline'
Default: block

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.

Anchor to display
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.

Anchor to hint
hint
'innerShadow' | {type: 'pill'; content: string}

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.

Anchor to id
id
string

A unique identifier for the component.

Anchor to maxBlockSize
maxBlockSize
< number | `${number}%` | 'fill' >

The maximum block size (maximum height in horizontal writing modes). The element won't grow taller than this value even if its content is longer.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's block size.
  • 'fill': Takes all the available space.

Learn more about the max-block-size property.

Anchor to maxInlineSize
maxInlineSize
< number | `${number}%` | 'fill' >

The maximum inline size (maximum width in horizontal writing modes). The element won't grow wider than this value.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's inline size.
  • 'fill': Takes all the available space.

Learn more about the max-inline-size property.

Anchor to minBlockSize
minBlockSize
< number | `${number}%` | 'fill' >

The minimum block size (minimum height in horizontal writing modes). The element won't shrink smaller than this value even if its content is shorter.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's block size.
  • 'fill': Takes all the available space.

Learn more about the min-block-size property.

Anchor to minInlineSize
minInlineSize
< number | `${number}%` | 'fill' >

The minimum inline size (minimum width in horizontal writing modes). The element won't shrink narrower than this value.

  • number: The size in pixels.
  • `${number}%`: The size as a percentage of the parent container's inline size.
  • 'fill': Takes all the available space.

Learn more about the min-inline-size property.

Anchor to onScroll
onScroll
(args: ) => void

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

Anchor to onScrolledToEdge
onScrolledToEdge
(args: ) => void

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

Anchor to padding
padding
<<>>

The padding on all edges of the element, using a shorthand syntax. You can specify one, two, or four values following the CSS shorthand convention.

  • T: A single value applied uniformly to all edges.
  • [T, T]: The first value applies to block-start and block-end, the second to inline-start and inline-end.
  • [T, T, T, T]: Values apply to block-start, inline-end, block-end, and inline-start respectively.
Anchor to scrollTo
scrollTo
number | HTMLElement

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.

Anchor to borderRadius
borderRadius
< <> >
Deprecated

Use cornerRadius instead.

The corner radius of the element. Accepts a single value for all corners or a shorthand tuple for per-corner control.

Anchor to ExamplesExamples

Anchor to Basic ScrollviewBasic Scrollview

Basic Scrollview

Example

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);
});

Anchor to RelatedRelated

UtilityStyleHelper
Was this page helpful?