ScrollView

Anchor to scrollviewpropsScrollViewProps

Anchor to background

background

MaybeConditionalStyle<Background>

Default: 'transparent'

Adjust the background.

Anchor to border

border

MaybeResponsiveConditionalStyle<MaybeShorthandProperty<BorderStyle>>

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

Anchor to borderWidth

borderWidth

MaybeResponsiveConditionalStyle< MaybeShorthandProperty<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

Anchor to cornerRadius

cornerRadius

MaybeResponsiveConditionalStyle< MaybeShorthandProperty<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.

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

MaybeResponsiveConditionalStyle<'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

MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >

Adjust the maximum block size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.

See MDN explanation of maxBlockSize.

Anchor to maxInlineSize

maxInlineSize

MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >

Adjust the maximum inline size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.

See MDN explanation of maxInlineSize.

Anchor to minBlockSize

minBlockSize

MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >

Adjust the block size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.

See MDN explanation of minBlockSize.

Anchor to minInlineSize

minInlineSize

MaybeResponsiveConditionalStyle< number | `${number}%` | 'fill' >

Adjust the minimum inline size.

number: size in pixels.

`${number}%`: size in percentages.

fill: takes all the available space.\

See MDN explanation of minInlineSize.

Anchor to onScroll

onScroll

(args: ScrollViewEvent) => 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: ScrollViewEvent) => void

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

Anchor to padding

padding

MaybeResponsiveConditionalStyle<MaybeShorthandProperty<Spacing>>

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

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.

T | ConditionalStyle<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>[];
}

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

'transparent' | 'base' | 'subdued'

T | ConditionalStyle<T, ViewportSizeCondition>

export interface ViewportSizeCondition<T = ViewportInlineSize> {
  viewportInlineSize: {min: T};
}

T | ShorthandProperty<T>

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

'base' | 'dashed' | 'dotted' | 'none'

'base' | 'medium' | 'thick'

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

'tight' | 'loose'

export interface ScrollViewEvent {
  /**
   * The current scroll position, in pixels.
   */
  position: {
    /** The current scroll horizontal position, in pixels.*/
    inline: number;
    /** The current scroll vertical position, in pixels.*/
    block: number;
  };
  /**
   * A flag to indicate if the scroll is at the start or end of an axis.
   */
  scrolledTo: {
    /** A flag to indicate if the scroll is at the start or end of cross axis. */
    inline: 'start' | 'end' | null;
    /** A flag to indicate if the scroll is at the start or end of main axis. */
    block: 'start' | 'end' | null;
  };
}

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