@cdx-ui/components 0.2.3 → 0.2.4

package/docs/components/carousel/content.md

@@ -0,0 +1,416 @@
+# Carousel (https://design.candescent.com/docs/components/carousel)
+
+Resources: [Figma](https://www.figma.com/design/0lEVMVlLj8ZS4fgItr3pmd/%E2%AD%90-Forge-DS--Components?node-id=11619-607), [Storybook](https://victorious-wave-0daadf00f.6.azurestaticapps.net/?path=/story/surfaces-carousel--default)
+
+A swipeable carousel built on [`react-native-reanimated-carousel`](https://rn-carousel.dev). Compose with `Carousel.Pagination` for dot indicators, `Carousel.PrevButton` / `Carousel.NextButton` for optional ghost icon navigation, or use `useCarousel()` for sibling composition and imperative control.
+
+```tsx
+import { Carousel, useCarousel } from '@cdx-ui/components';
+```
+
+## Basic
+
+```tsx
+import { Carousel } from '@cdx-ui/components';
+import { CarouselSlide, SLIDES } from './_slides';
+
+// Carousel lays out slides from its container size, so the demo sets one. Sizing guidance for
+// Carousel is still open.
+export default function CarouselBasicDemo() {
+  return (
+    <Carousel
+      data={SLIDES}
+      style={{ width: 320, height: 220 }}
+      loop
+      renderItem={({ item }) => <CarouselSlide {...item} />}
+    />
+  );
+}
+```
+
+## With pagination
+
+Nest `Carousel.Pagination` inside `Carousel` to bind dots to scroll progress via context — no manual wiring required.
+
+```tsx
+import { Box, Carousel } from '@cdx-ui/components';
+import { CarouselSlide, SLIDES } from './_slides';
+
+// Carousel lays out slides from its container size, so the demo sets one. Sizing guidance for
+// Carousel is still open.
+export default function CarouselWithPaginationDemo() {
+  return (
+    <Box className="w-80 gap-3">
+      <Carousel
+        data={SLIDES}
+        style={{ width: 320, height: 220 }}
+        loop
+        renderItem={({ item }) => <CarouselSlide {...item} />}
+      >
+        <Carousel.Pagination data={SLIDES} />
+      </Carousel>
+    </Box>
+  );
+}
+```
+
+## Prev / Next buttons
+
+Optional ghost icon prev/next controls mirroring `Carousel.Pagination`'s nested vs sibling wiring. Nest inside `Carousel` for zero-prop controls below the track, or use `useCarousel()` for sibling placement — header row with space between a title and the buttons, or an `HStack` flanking the track.
+
+```tsx
+import { Box, Carousel, Heading, HStack, useCarousel, VStack } from '@cdx-ui/components';
+import { CarouselSlide, SLIDES } from './_slides';
+
+function HeaderRowSample() {
+  const { ref, progress } = useCarousel();
+
+  return (
+    <Box className="w-80 gap-3">
+      <HStack className="items-center justify-between">
+        <Heading size="sm">Featured</Heading>
+        <HStack space="sm">
+          <Carousel.PrevButton
+            itemCount={SLIDES.length}
+            progress={progress}
+            carouselRef={ref}
+            loop={false}
+          />
+          <Carousel.NextButton
+            itemCount={SLIDES.length}
+            progress={progress}
+            carouselRef={ref}
+            loop={false}
+          />
+        </HStack>
+      </HStack>
+      <Carousel
+        ref={ref}
+        data={SLIDES}
+        style={{ width: 320, height: 220 }}
+        loop={false}
+        onProgressChange={progress}
+        renderItem={({ item }) => <CarouselSlide {...item} />}
+      />
+    </Box>
+  );
+}
+
+function FlankingSample() {
+  const { ref, progress } = useCarousel();
+
+  return (
+    <HStack className="max-w-full items-center justify-center" space="sm">
+      <Carousel.PrevButton
+        itemCount={SLIDES.length}
+        progress={progress}
+        carouselRef={ref}
+        loop={false}
+      />
+      <Carousel
+        ref={ref}
+        data={SLIDES}
+        style={{ width: 252, height: 220 }}
+        loop={false}
+        onProgressChange={progress}
+        renderItem={({ item }) => <CarouselSlide {...item} />}
+      />
+      <Carousel.NextButton
+        itemCount={SLIDES.length}
+        progress={progress}
+        carouselRef={ref}
+        loop={false}
+      />
+    </HStack>
+  );
+}
+
+// Carousel lays out slides from its container size, so the demo sets one. Sizing guidance for
+// Carousel is still open.
+export default function CarouselPrevNextDemo() {
+  return (
+    <VStack space="4xl" className="items-center">
+      <HeaderRowSample />
+      <FlankingSample />
+    </VStack>
+  );
+}
+```
+
+## Vertical
+
+Set `vertical` to lay items out top-to-bottom instead of left-to-right.
+
+```tsx
+import { Carousel } from '@cdx-ui/components';
+import { CarouselSlide, SLIDES } from './_slides';
+
+// Carousel lays out slides from its container size, so the demo sets one. Sizing guidance for
+// Carousel is still open.
+export default function CarouselVerticalDemo() {
+  return (
+    <Carousel
+      data={SLIDES}
+      style={{ width: 320, height: 420 }}
+      vertical
+      renderItem={({ item }) => <CarouselSlide {...item} />}
+    />
+  );
+}
+```
+
+## Parallax mode
+
+One of the library's built-in layout modes — adjacent items scale down and shift, creating a parallax depth effect while scrolling. Configure via `modeConfig`.
+
+```tsx
+import { Carousel } from '@cdx-ui/components';
+import { CarouselSlide, SLIDES } from './_slides';
+
+// Carousel lays out slides from its container size, so the demo sets one. Sizing guidance for
+// Carousel is still open.
+export default function CarouselParallaxDemo() {
+  return (
+    <Carousel
+      data={SLIDES}
+      style={{ width: 320, height: 220 }}
+      mode="parallax"
+      modeConfig={{ parallaxScrollingScale: 0.9, parallaxScrollingOffset: 50 }}
+      renderItem={({ item }) => <CarouselSlide {...item} />}
+    />
+  );
+}
+```
+
+## Autoplay
+
+Set `autoPlay` and `loop` to advance items automatically. Uses the sibling-composition pattern via `useCarousel()` to bind `Carousel.Pagination` outside of `Carousel`.
+
+```tsx
+import { Box, Carousel, useCarousel } from '@cdx-ui/components';
+import { CarouselSlide, SLIDES } from './_slides';
+
+// Carousel lays out slides from its container size, so the demo sets one. Sizing guidance for
+// Carousel is still open.
+export default function CarouselAutoplayDemo() {
+  const { ref, progress } = useCarousel();
+
+  return (
+    <Box className="w-80 gap-3">
+      <Carousel
+        ref={ref}
+        data={SLIDES}
+        style={{ width: 320, height: 220 }}
+        loop
+        autoPlay
+        autoPlayInterval={2000}
+        onProgressChange={progress}
+        renderItem={({ item }) => <CarouselSlide {...item} />}
+      />
+      <Carousel.Pagination data={SLIDES} progress={progress} carouselRef={ref} loop />
+    </Box>
+  );
+}
+```
+
+## API
+
+### Carousel
+
+Forge-owned additions on top of the adopted library's props:
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `className?` | `string` | — | — |
+| `children?` | `ReactNode` | — | Rendered inside the carousel's progress-sharing provider — use to compose `Carousel.Pagination`, `Carousel.PrevButton`, and `Carousel.NextButton`. |
+
+Also accepts all props from [`react-native-reanimated-carousel`](https://rn-carousel.dev/props), including:
+
+| Prop               | Type                                                                                  | Default | Description                                                                      |
+| ------------------ | ------------------------------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------- |
+| `data`             | `T[]`                                                                                 | —       | Items to render                                                                  |
+| `renderItem`       | `(info: { item: T; index: number }) => ReactNode`                                     | —       | Renders each item                                                                |
+| `loop`             | `boolean`                                                                             | `true`  | Loop back to the first item after the last                                       |
+| `autoPlay`         | `boolean`                                                                             | `false` | Automatically advance items                                                      |
+| `vertical`         | `boolean`                                                                             | `false` | Lay items out vertically instead of horizontally                                 |
+| `mode`             | `'parallax' \| 'horizontal-stack' \| 'vertical-stack'`                                | —       | Built-in layout mode                                                             |
+| `onProgressChange` | `((offsetProgress: number, absoluteProgress: number) => void) \| SharedValue<number>` | —       | Called on scroll; pass a `SharedValue` to adopt it as the shared progress source |
+
+## Sub-components
+
+### Carousel.Pagination
+
+Dot indicators bound to the carousel's scroll progress. Nest inside `Carousel` to read shared progress via context, or pass `progress` / `carouselRef` explicitly for sibling composition.
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `data` | `unknown[]` | — | Carousel items — must be the same array (or same length) passed to `Carousel`'s `data`. |
+| `horizontal?` | `boolean` | `true (horizontal)` | Lay dots out vertically instead of horizontally. |
+| `renderItem?` | `((item: unknown, index: number) => ReactNode)` | — | Custom content per dot; defaults to the library's built-in dot rendering. |
+| `size?` | `number` | — | Dot size in pixels (both width and height). |
+| `carouselName?` | `string` | — | Included in the default accessibility label, e.g. `"Slide 1 of 4 - {carouselName}"`. |
+| `paginationItemAccessibility?` | `((index: number, length: number) => CarouselPaginationItemAccessibilityOverrides)` | — | Per-dot accessibility overrides. Defaults to `"Slide N of M"` / `"Go to Slide N of M"`. |
+| `className?` | `string` | — | — |
+| `progress?` | `SharedValue<number>` | — | Explicit progress value — only required when rendered outside `<Carousel>` (sibling composition). |
+| `carouselRef?` | `RefObject<ICarouselInstance \| null>` | — | Explicit carousel ref for the default press-to-navigate behavior — only required outside `<Carousel>`. |
+| `loop?` | `boolean` | — | Mirrors `Carousel`'s `loop` prop for shortest-path dot navigation. Defaults to `true` (same as `Carousel`) when omitted outside context. |
+| `onPress?` | `((index: number) => void)` | — | Overrides the default press-to-navigate behavior (`scrollTo({ index })`). |
+
+### Carousel.PrevButton / Carousel.NextButton
+
+Ghost `IconButton` prev/next controls. Nest inside `Carousel` to read context, or pass `progress`, `carouselRef`, `itemCount`, `loop`, and `vertical` explicitly for sibling composition.
+
+| Prop | Type | Default | Description |
+| --- | --- | --- | --- |
+| `itemCount?` | `number` | — | Mirrors `Carousel`'s `data.length` — only required when rendered outside `<Carousel>`. |
+| `progress?` | `SharedValue<number>` | — | Explicit progress value — only required when rendered outside `<Carousel>`. |
+| `carouselRef?` | `RefObject<ICarouselInstance \| null>` | — | Explicit carousel ref — only required outside `<Carousel>` (unless `onPress` is provided). |
+| `loop?` | `boolean` | — | Mirrors `Carousel`'s `loop` prop for bounds-aware disabled state. Defaults to `true` (same as `Carousel`) when omitted outside context. |
+| `vertical?` | `boolean` | — | Mirrors `Carousel`'s `vertical` prop for default icons and accessibility labels. Defaults to `false` when omitted outside context. |
+| `onPress?` | `(() => void)` | — | Overrides the default press-to-navigate behavior (`prev` / `next` with `{ animated: true }`). |
+| `disabled?` | `boolean` | — | Manual override; when omitted, derived from `loop` and `progress` at bounds. |
+| `as?` | `ForgeIcon` | — | Forge icon component — defaults to direction-appropriate chevrons or arrows. |
+| `accessibilityLabel?` | `string` | — | Overrides default `"Previous slide"` / `"Next slide"` (or item labels when `vertical`). |
+| `children?` | `React.ReactNode \| ((state: PressableStateCallbackType) => React.ReactNode)` | — | Either children or a render prop that receives a boolean reflecting whether the component is currently pressed. |
+| `style?` | `StyleProp<ViewStyle> \| ((state: PressableStateCallbackType) => StyleProp<ViewStyle>)` | — | Either view styles or a function that receives a boolean reflecting whether the component is currently pressed and returns view styles. |
+| `hitSlop?` | `number \| Insets \| null` | — | Additional distance outside of this view in which a press is detected. |
+| `id?` | `string` | — | Used to reference react managed views from native code. |
+| `needsOffscreenAlphaCompositing?` | `boolean` | — | Whether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background). Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU. |
+| `onLayout?` | `((event: LayoutChangeEvent) => void)` | — | Invoked on mount and layout changes with {nativeEvent: { layout: {x, y, width, height}}}. |
+| `pointerEvents?` | `'box-none' \| 'none' \| 'box-only' \| 'auto'` | — | In the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class: .box-none { pointer-events: none; } .box-none * { pointer-events: all; } box-only is the equivalent of .box-only { pointer-events: all; } .box-only * { pointer-events: none; } But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform. |
+| `removeClippedSubviews?` | `boolean` | — | This is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews). |
+| `testID?` | `string` | — | Used to locate this view in end-to-end tests. |
+| `nativeID?` | `string` | — | Used to reference react managed views from native code. |
+| `collapsable?` | `boolean` | — | Views that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy. |
+| `collapsableChildren?` | `boolean` | — | Setting to false prevents direct children of the view from being removed from the native view hierarchy, similar to the effect of setting `collapsable={false}` on each child. |
+| `className?` | `string` | — | — |
+| `onBlur?` | `((event: NativeSyntheticEvent<TargetedEvent>) => void) \| null` | — | Called after the element loses focus. |
+| `onFocus?` | `((event: NativeSyntheticEvent<TargetedEvent>) => void) \| null` | — | Called after the element is focused. |
+| `renderToHardwareTextureAndroid?` | `boolean` | — | Whether this view should render itself (and all of its children) into a single hardware texture on the GPU. On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation. |
+| `focusable?` | `boolean` | — | Whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard. |
+| `tabIndex?` | `0 \| -1` | — | Indicates whether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard. See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex for more details. Supports the following values: - 0 (View is focusable) - -1 (View is not focusable) |
+| `shouldRasterizeIOS?` | `boolean` | — | Whether this view should be rendered as a bitmap before compositing. On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame. Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property. |
+| `isTVSelectable?` | `boolean` | — | *(Apple TV only)* When set to true, this view will be focusable and navigable using the Apple TV remote. |
+| `hasTVPreferredFocus?` | `boolean` | — | **Deprecated.** *(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view. |
+| `tvParallaxShiftDistanceX?` | `number` | — | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0. |
+| `tvParallaxShiftDistanceY?` | `number` | — | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0. |
+| `tvParallaxTiltAngle?` | `number` | — | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05. |
+| `tvParallaxMagnification?` | `number` | — | *(Apple TV only)* May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0. |
+| `onStartShouldSetResponder?` | `((event: GestureResponderEvent) => boolean)` | — | Does this view want to become responder on the start of a touch? |
+| `onMoveShouldSetResponder?` | `((event: GestureResponderEvent) => boolean)` | — | Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness? |
+| `onResponderEnd?` | `((event: GestureResponderEvent) => void)` | — | If the View returns true and attempts to become the responder, one of the following will happen: |
+| `onResponderGrant?` | `((event: GestureResponderEvent) => void)` | — | The View is now responding for touch events. This is the time to highlight and show the user what is happening |
+| `onResponderReject?` | `((event: GestureResponderEvent) => void)` | — | Something else is the responder right now and will not release it |
+| `onResponderMove?` | `((event: GestureResponderEvent) => void)` | — | The user is moving their finger |
+| `onResponderRelease?` | `((event: GestureResponderEvent) => void)` | — | Fired at the end of the touch, ie "touchUp" |
+| `onResponderStart?` | `((event: GestureResponderEvent) => void)` | — | — |
+| `onResponderTerminationRequest?` | `((event: GestureResponderEvent) => boolean)` | — | Something else wants to become responder. Should this view release the responder? Returning true allows release |
+| `onResponderTerminate?` | `((event: GestureResponderEvent) => void)` | — | The responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS) |
+| `onStartShouldSetResponderCapture?` | `((event: GestureResponderEvent) => boolean)` | — | onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable. However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true. |
+| `onMoveShouldSetResponderCapture?` | `((event: GestureResponderEvent) => boolean)` | — | onStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable. However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true. |
+| `onTouchStart?` | `((event: GestureResponderEvent) => void)` | — | — |
+| `onTouchMove?` | `((event: GestureResponderEvent) => void)` | — | — |
+| `onTouchEnd?` | `((event: GestureResponderEvent) => void)` | — | — |
+| `onTouchCancel?` | `((event: GestureResponderEvent) => void)` | — | — |
+| `onTouchEndCapture?` | `((event: GestureResponderEvent) => void)` | — | — |
+| `onPointerEnter?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerEnterCapture?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerLeave?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerLeaveCapture?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerMove?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerMoveCapture?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerCancel?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerCancelCapture?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerDown?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerDownCapture?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerUp?` | `((event: PointerEvent) => void)` | — | — |
+| `onPointerUpCapture?` | `((event: PointerEvent) => void)` | — | — |
+| `accessible?` | `boolean` | — | When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible. |
+| `accessibilityActions?` | `readonly Readonly<{ name: AccessibilityActionName \| string; label?: string; }>[]` | — | Provides an array of custom actions available for accessibility. |
+| `aria-label?` | `string` | — | Alias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/facebook/react-native/issues/34424 |
+| `accessibilityRole?` | `'none' \| 'button' \| 'togglebutton' \| 'link' \| 'search' \| 'image' \| 'keyboardkey' \| 'text' \| 'adjustable' \| 'imagebutton' \| 'header' \| 'summary' \| 'alert' \| 'checkbox' \| 'combobox' \| 'menu' \| 'menubar' \| 'menuitem' \| 'progressbar' \| 'radio' \| 'radiogroup' \| 'scrollbar' \| 'spinbutton' \| 'switch' \| 'tab' \| 'tabbar' \| 'tablist' \| 'timer' \| 'list' \| 'toolbar'` | — | Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on. |
+| `accessibilityState?` | `AccessibilityState` | — | Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on. |
+| `aria-busy?` | `boolean` | — | alias for accessibilityState see https://reactnative.dev/docs/accessibility#accessibilitystate |
+| `aria-checked?` | `boolean \| "mixed"` | — | — |
+| `aria-disabled?` | `boolean` | — | — |
+| `aria-expanded?` | `boolean` | — | — |
+| `aria-selected?` | `boolean` | — | — |
+| `accessibilityHint?` | `string` | — | An accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label. |
+| `accessibilityValue?` | `AccessibilityValue` | — | Represents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum). |
+| `aria-valuemax?` | `number` | — | — |
+| `aria-valuemin?` | `number` | — | — |
+| `aria-valuenow?` | `number` | — | — |
+| `aria-valuetext?` | `string` | — | — |
+| `onAccessibilityAction?` | `((event: AccessibilityActionEvent) => void)` | — | When `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action. |
+| `importantForAccessibility?` | `'auto' \| 'yes' \| 'no' \| 'no-hide-descendants'` | — | [Android] Controlling if a view fires accessibility events and if it is reported to accessibility services. |
+| `aria-hidden?` | `boolean` | — | A value indicating whether the accessibility elements contained within this accessibility element are hidden. |
+| `aria-modal?` | `boolean` | — | — |
+| `role?` | `'none' \| 'button' \| 'link' \| 'summary' \| 'alert' \| 'checkbox' \| 'combobox' \| 'menu' \| 'menubar' \| 'menuitem' \| 'progressbar' \| 'radio' \| 'radiogroup' \| 'scrollbar' \| 'spinbutton' \| 'switch' \| 'tab' \| 'tablist' \| 'timer' \| 'list' \| 'toolbar' \| 'alertdialog' \| 'application' \| 'article' \| 'banner' \| 'cell' \| 'columnheader' \| 'complementary' \| 'contentinfo' \| 'definition' \| 'dialog' \| 'directory' \| 'document' \| 'feed' \| 'figure' \| 'form' \| 'grid' \| 'group' \| 'heading' \| 'img' \| 'listitem' \| 'log' \| 'main' \| 'marquee' \| 'math' \| 'meter' \| 'navigation' \| 'note' \| 'option' \| 'presentation' \| 'region' \| 'row' \| 'rowgroup' \| 'rowheader' \| 'searchbox' \| 'separator' \| 'slider' \| 'status' \| 'table' \| 'tabpanel' \| 'term' \| 'tooltip' \| 'tree' \| 'treegrid' \| 'treeitem'` | — | Indicates to accessibility services to treat UI component like a specific role. |
+| `accessibilityLabelledBy?` | `string \| string[]` | — | Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element. |
+| `aria-labelledby?` | `string` | — | Identifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element. |
+| `accessibilityLiveRegion?` | `'none' \| 'polite' \| 'assertive'` | — | Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. |
+| `aria-live?` | `'polite' \| 'assertive' \| 'off'` | — | Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only. |
+| `screenReaderFocusable?` | `boolean` | — | Enables the view to be screen reader focusable, not keyboard focusable. |
+| `accessibilityElementsHidden?` | `boolean` | — | A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader. |
+| `accessibilityViewIsModal?` | `boolean` | — | A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. |
+| `onAccessibilityEscape?` | `(() => void)` | — | When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers). |
+| `onAccessibilityTap?` | `(() => void)` | — | When `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture. |
+| `onMagicTap?` | `(() => void)` | — | When accessible is true, the system will invoke this function when the user performs the magic tap gesture. |
+| `accessibilityIgnoresInvertColors?` | `boolean` | — | https://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios |
+| `accessibilityLanguage?` | `string` | — | By using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios |
+| `accessibilityShowsLargeContentViewer?` | `boolean` | — | A Boolean value that indicates whether or not to show the item in the large content viewer. Available on iOS 13.0+ https://reactnative.dev/docs/accessibility#accessibilityshowslargecontentviewer |
+| `accessibilityLargeContentTitle?` | `string` | — | When `accessibilityShowsLargeContentViewer` is set, this string will be used as title for the large content viewer. https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle |
+| `accessibilityRespondsToUserInteraction?` | `boolean` | — | Blocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible. |
+| `size?` | `'default' \| 'small' \| null` | — | — |
+| `color?` | `'neutral' \| 'action' \| 'danger' \| null` | — | — |
+| `iconClassName?` | `string` | — | Passed through to the underlying `Icon`. |
+| `onHoverIn?` | `((event: MouseEvent) => void) \| null` | — | Called when the hover is activated to provide visual feedback. |
+| `onHoverOut?` | `((event: MouseEvent) => void) \| null` | — | Called when the hover is deactivated to undo visual feedback. |
+| `onPressIn?` | `((event: GestureResponderEvent) => void) \| null` | — | Called when a touch is engaged before `onPress`. |
+| `onPressOut?` | `((event: GestureResponderEvent) => void) \| null` | — | Called when a touch is released before `onPress`. |
+| `onLongPress?` | `((event: GestureResponderEvent) => void) \| null` | — | Called when a long-tap gesture is detected. |
+| `cancelable?` | `boolean \| null` | — | Whether a press gesture can be interrupted by a parent gesture such as a scroll event. Defaults to true. |
+| `delayHoverIn?` | `number \| null` | — | Duration to wait after hover in before calling `onHoverIn`. |
+| `delayHoverOut?` | `number \| null` | — | Duration to wait after hover out before calling `onHoverOut`. |
+| `delayLongPress?` | `number \| null` | — | Duration (in milliseconds) from `onPressIn` before `onLongPress` is called. |
+| `pressRetentionOffset?` | `number \| Insets \| null` | — | Additional distance outside of this view in which a touch is considered a press before `onPressOut` is triggered. |
+| `android_disableSound?` | `boolean \| null` | — | If true, doesn't play system sound on touch. |
+| `android_ripple?` | `PressableAndroidRippleConfig \| null` | — | Enables the Android ripple effect and configures its color. |
+| `testOnly_pressed?` | `boolean \| null` | — | Used only for documentation or testing (e.g. snapshot testing). |
+| `unstable_pressDelay?` | `number` | — | Duration (in milliseconds) to wait after press down before calling onPressIn. |
+
+## Hook
+
+### useCarousel
+
+Convenience hook for sibling composition and imperative navigation. Creates a ref and shared progress value:
+
+```tsx
+const { ref, progress, next, prev, scrollTo } = useCarousel(); // optional: useCarousel({ defaultIndex: 2 })
+```
+
+| Return     | Type                                             | Description                                                                                             |
+| ---------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
+| `ref`      | `RefObject<CarouselRef \| null>`                 | Pass to `Carousel`                                                                                      |
+| `progress` | `SharedValue<number>`                            | Pass to `Carousel`'s `onProgressChange` and sibling `Carousel.Pagination` / nav button `progress` props |
+| `next`     | `(opts?) => void`                                | Advance to the next item                                                                                |
+| `prev`     | `(opts?) => void`                                | Go to the previous item                                                                                 |
+| `scrollTo` | `(opts?: { index?, count?, animated? }) => void` | Jump to a specific index                                                                                |
+
+For advanced imperative control, access `ref.current` directly (`CarouselRef`).
+
+## Accessibility
+
+| Aspect              | Behavior                                                                                                                                                                                                                                                         |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Gesture model       | Swipe/pan via `react-native-gesture-handler`. The underlying library does not document a dedicated keyboard equivalent for web — arrow-key navigation is not built in.                                                                                           |
+| Pagination dots     | Each dot has `accessibilityRole="button"`, a default `accessibilityLabel` of `"Slide N of M"` (plus `carouselName` if provided), a default `accessibilityHint` of `"Go to Slide N of M"` (empty when already selected), and `accessibilityState={{ selected }}`. |
+| Prev / Next buttons | Ghost `IconButton`s with `accessibilityRole="button"` and default labels `"Previous slide"` / `"Next slide"` (horizontal) or `"Previous item"` / `"Next item"` (vertical). `accessibilityState={{ disabled }}` reflects bounds when `loop={false}`.              |
+| Overrides           | Per-dot via `paginationItemAccessibility`. Nav labels via `accessibilityLabel`; icons via `as`.                                                                                                                                                                  |
+| Autoplay            | Does not pause automatically for reduced-motion preferences — out of scope for this component.                                                                                                                                                                   |
+
+## Constraints
+
+- `Carousel.Pagination` must either be rendered inside `<Carousel>` (reads shared progress and ref via context) or receive explicit `progress` and `carouselRef` props (sibling composition via `useCarousel()`) — otherwise it throws. A custom `onPress` may substitute for `carouselRef`.
+- `Carousel.PrevButton` and `Carousel.NextButton` follow the same nested vs sibling contract as `Carousel.Pagination`, and additionally require `itemCount` when rendered outside `<Carousel>`.
+- When using `defaultIndex` with sibling composition, seed progress via `useCarousel({ defaultIndex })` so pagination highlights the correct initial dot.