@storybook/react-native-ui-common 10.4.0 → 10.4.1-canary-20260510001247

package/dist/index.d.ts

@@ -1,160 +1,180 @@
-import * as react from 'react';
-import { ReactElement, FC, PropsWithChildren, ReactNode, SyntheticEvent, DependencyList, Dispatch, useState } from 'react';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import * as _storybook_react_native_theming from '@storybook/react-native-theming';
-import { useTheme, Theme } from '@storybook/react-native-theming';
-import * as react_native from 'react-native';
-import { TouchableOpacityProps, PressableProps, ViewStyle, TextStyle, ImageStyle, StyleProp } from 'react-native';
-import { StoryContext, Args } from 'storybook/internal/csf';
-import { ReactRenderer } from '@storybook/react';
-import { State, StoriesHash, API, IndexHash } from 'storybook/manager-api';
-import { StatusesByStoryIdAndTypeId, StatusValue, API_IndexHash, API_PreparedStoryIndex, StoryIndexV2, StoryIndexV3, API_Provider, DocsOptions } from 'storybook/internal/types';
+import * as _$react from "react";
+import { DependencyList, Dispatch, FC, PropsWithChildren, ReactElement, ReactNode, SetStateAction, SyntheticEvent } from "react";
+import * as _$react_native0 from "react-native";
+import { ImageStyle, PressableProps, StyleProp, TextStyle, TouchableOpacityProps, ViewStyle } from "react-native";
+import * as _$_storybook_react_native_theming0 from "@storybook/react-native-theming";
+import { Theme } from "@storybook/react-native-theming";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+import { Args, StoryContext } from "storybook/internal/csf";
+import { ReactRenderer } from "@storybook/react";
+import { API, IndexHash, State, StoriesHash } from "storybook/manager-api";
+import { API_IndexHash, API_PreparedStoryIndex, API_Provider, DocsOptions, StatusValue, StatusesByStoryIdAndTypeId, StoryIndexV2, StoryIndexV3 } from "storybook/internal/types";
 
+//#region src/Button.d.ts
 interface ButtonProps extends TouchableOpacityProps {
-    asChild?: boolean;
-    size?: 'small' | 'medium';
-    padding?: 'small' | 'medium';
-    variant?: 'outline' | 'solid' | 'ghost';
-    disabled?: boolean;
-    active?: boolean;
-    animation?: 'none' | 'rotate360' | 'glow' | 'jiggle';
-    text?: string;
-    Icon?: (props: {
-        color: string;
-    }) => ReactElement;
+  asChild?: boolean;
+  size?: 'small' | 'medium';
+  padding?: 'small' | 'medium';
+  variant?: 'outline' | 'solid' | 'ghost';
+  disabled?: boolean;
+  active?: boolean;
+  animation?: 'none' | 'rotate360' | 'glow' | 'jiggle';
+  text?: string;
+  Icon?: (props: {
+    color: string;
+  }) => ReactElement;
 }
-declare const Button: react.ForwardRefExoticComponent<ButtonProps & react.RefAttributes<any>>;
-declare const ButtonText: _storybook_react_native_theming.StyledComponent<react_native.TextProps & {
-    theme?: useTheme;
-    as?: React.ElementType;
+declare const Button: _$react.ForwardRefExoticComponent<ButtonProps & _$react.RefAttributes<any>>;
+declare const ButtonText: _$_storybook_react_native_theming0.StyledComponent<_$react_native0.TextProps & {
+  theme?: _$_storybook_react_native_theming0.Theme;
+  as?: React.ElementType;
 } & {
-    variant: ButtonProps["variant"];
-    active: ButtonProps["active"];
+  variant: ButtonProps["variant"];
+  active: ButtonProps["active"];
 }, {}, {
-    ref?: react.Ref<react_native.Text>;
+  ref?: _$react.Ref<_$react_native0.Text>;
 }>;
-declare const ButtonIcon: ({ Icon, active, variant, }: {
-    Icon: (props: {
-        color: string;
-    }) => ReactElement;
-    variant: ButtonProps["variant"];
-    active: ButtonProps["active"];
-}) => react_jsx_runtime.JSX.Element;
-
-declare const IconButton: react.ForwardRefExoticComponent<ButtonProps & react.RefAttributes<unknown>>;
-
+declare const ButtonIcon: ({
+  Icon,
+  active,
+  variant
+}: {
+  Icon: (props: {
+    color: string;
+  }) => ReactElement;
+  variant: ButtonProps["variant"];
+  active: ButtonProps["active"];
+}) => _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/IconButton.d.ts
+declare const IconButton: _$react.ForwardRefExoticComponent<ButtonProps & _$react.RefAttributes<unknown>>;
+//#endregion
+//#region src/LayoutProvider.d.ts
 type LayoutContextType = {
-    isDesktop: boolean;
-    isMobile: boolean;
+  isDesktop: boolean;
+  isMobile: boolean;
 };
 declare const LayoutProvider: FC<PropsWithChildren>;
 declare const useLayout: () => LayoutContextType;
-
+//#endregion
+//#region src/StorageProvider.d.ts
 interface Storage {
-    getItem: (key: string) => Promise<string | null>;
-    setItem: (key: string, value: string) => Promise<void>;
+  getItem: (key: string) => Promise<string | null> | string | null;
+  setItem: (key: string, value: string) => Promise<void> | void;
 }
 declare const StorageProvider: FC<PropsWithChildren<{
-    storage: Storage;
+  storage: Storage;
 }>>;
 declare const useStorage: () => Storage;
-
+//#endregion
+//#region src/types.d.ts
 type HighlightRange = [number, number];
 type HighlightRanges = HighlightRange[];
 type Refs = State['refs'];
 type RefType = Refs[keyof Refs] & {
-    allStatuses?: StatusesByStoryIdAndTypeId;
+  allStatuses?: StatusesByStoryIdAndTypeId;
 };
 type Item = StoriesHash[keyof StoriesHash];
 type Dataset = Record<string, Item>;
 interface CombinedDataset {
-    hash: Refs;
-    entries: [string, RefType][];
+  hash: Refs;
+  entries: [string, RefType][];
 }
 interface ItemRef {
-    itemId: string;
-    refId: string;
+  itemId: string;
+  refId: string;
 }
 interface StoryRef {
-    storyId: string;
-    refId: string;
+  storyId: string;
+  refId: string;
 }
 type Highlight = ItemRef | null;
 type Selection = StoryRef | null;
 declare function isExpandType(x: any): x is ExpandType;
 interface ExpandType {
-    showAll: () => void;
-    totalCount: number;
-    moreCount: number;
+  showAll: () => void;
+  totalCount: number;
+  moreCount: number;
 }
 type SearchItem = Item & {
-    refId: string;
-    path: string[];
-    status?: StatusValue;
-    showAll?: () => void;
+  refId: string;
+  path: string[];
+  status?: StatusValue;
+  showAll?: () => void;
 };
 interface SearchResult {
-    item: SearchItem;
-    score: number | null;
-    matches: HighlightRanges[];
+  item: SearchItem;
+  score: number | null;
+  matches: HighlightRanges[];
 }
 type SearchResultProps = SearchResult & {
-    icon: string;
-    isHighlighted: boolean;
-    onPress: PressableProps['onPress'];
+  icon: string;
+  isHighlighted: boolean;
+  onPress: PressableProps['onPress'];
 };
 type GetSearchItemProps = (args: {
-    item: SearchResult;
-    index: number;
-    key: string;
+  item: SearchResult;
+  index: number;
+  key: string;
 }) => SearchResultProps;
 type SearchChildrenFn = (args: {
-    query: string;
-    results: SearchResult[];
-    isBrowsing: boolean;
-    closeMenu: (cb?: () => void) => void;
-    getItemProps: GetSearchItemProps;
-    highlightedIndex: number | null;
+  query: string;
+  results: SearchResult[];
+  isBrowsing: boolean;
+  closeMenu: (cb?: () => void) => void;
+  getItemProps: GetSearchItemProps;
+  highlightedIndex: number | null;
 }) => ReactNode;
 type SBUI = (props: {
-    story?: StoryContext<ReactRenderer, Args>;
-    storyHash: API_IndexHash;
-    setStory: (storyId: string) => void;
-    storage: Storage;
-    theme: Theme;
-    storyBackgroundColor?: string;
-    children: ReactElement;
+  story?: StoryContext<ReactRenderer, Args>;
+  storyHash: API_IndexHash;
+  setStory: (storyId: string) => void;
+  storage: Storage;
+  theme: Theme;
+  storyBackgroundColor?: string;
+  children: ReactElement;
 }) => ReactElement;
-
+//#endregion
+//#region src/util/StoryHash.d.ts
 type ToStoriesHashOptions = {
-    provider: API_Provider<API>;
-    docsOptions: DocsOptions;
-    filters: State['filters'];
-    allStatuses: StatusesByStoryIdAndTypeId;
+  provider: API_Provider<API>;
+  docsOptions: DocsOptions;
+  filters: State['filters'];
+  allStatuses: StatusesByStoryIdAndTypeId;
 };
 declare const intersect: <T>(a: T[], b: T[]) => T[];
 declare const merge: <TObj = any>(a: TObj, ...b: Partial<TObj>[]) => TObj;
 declare const noArrayMerge: <TObj = any>(a: TObj, ...b: Partial<TObj>[]) => TObj;
-declare const transformStoryIndexToStoriesHash: (input: API_PreparedStoryIndex | StoryIndexV2 | StoryIndexV3, { provider, docsOptions, filters, allStatuses }: ToStoriesHashOptions) => API_IndexHash | any;
+declare const transformStoryIndexToStoriesHash: (input: API_PreparedStoryIndex | StoryIndexV2 | StoryIndexV3, {
+  provider,
+  docsOptions,
+  filters,
+  allStatuses
+}: ToStoriesHashOptions) => API_IndexHash | any;
 declare const transformStoryIndexV2toV3: (index: StoryIndexV2) => StoryIndexV3;
 declare const transformStoryIndexV3toV4: (index: StoryIndexV3) => API_PreparedStoryIndex;
 declare const transformStoryIndexV4toV5: (index: API_PreparedStoryIndex) => API_PreparedStoryIndex;
-
+//#endregion
+//#region src/util/tree.d.ts
 declare const createId: (itemId: string, refId?: string) => string;
 declare const prevent: (e: SyntheticEvent) => boolean;
 declare const get: (id: string, dataset: Dataset) => Item;
 declare const getParent: (id: string, dataset: Dataset) => Item;
 declare const getParents: (id: string, dataset: Dataset) => Item[];
-declare const getAncestorIds: (data: IndexHash, id: string) => string[];
+declare const getAncestorIds: (data: IndexHash, id: string | null) => string[];
 declare const getDescendantIds: (data: IndexHash, id: string, skipLeafs: boolean) => string[];
 declare function getPath(item: Item, ref: RefType): string[];
 declare const searchItem: (item: Item, ref: RefType) => SearchItem;
 declare function cycle<T>(array: T[], index: number, delta: number): number;
 declare const getStateType: (isLoading: boolean, isAuthRequired: boolean, isError: boolean, isEmpty: boolean) => "auth" | "error" | "loading" | "empty" | "ready";
-declare const isAncestor: (element?: Element, maybeAncestor?: Element) => boolean;
+type ElementLike = {
+  parentElement?: ElementLike | null;
+};
+declare const isAncestor: (element?: ElementLike | null, maybeAncestor?: ElementLike | null) => boolean;
 declare const removeNoiseFromName: (storyName: string) => string;
 declare const isStoryHoistable: (storyName: string, componentName: string) => boolean;
-
+//#endregion
+//#region src/util/useStyle.d.ts
 /**
  * A hook to memoize a style. Uses `ViewStyle` per default, but can be used with other styles deriving from `FlexStyle` as well, such as `TextStyle`.
  * @param styleFactory The function that returns a style
@@ -172,30 +192,40 @@ declare const isStoryHoistable: (storyName: string, componentName: string) => bo
  * );
  */
 declare const useStyle: <TStyle extends ViewStyle | TextStyle | ImageStyle, TOutput extends StyleProp<TStyle>>(styleFactory: () => TOutput, deps?: DependencyList) => TOutput;
-
+//#endregion
+//#region src/util/string.d.ts
 declare function startCase(str: string): string;
-
+//#endregion
+//#region src/hooks/useExpanded.d.ts
 type ExpandedState = Record<string, boolean>;
 interface ExpandAction {
-    ids: string[];
-    value: boolean;
+  ids: string[];
+  value: boolean;
 }
 interface ExpandedProps {
-    refId: string;
-    data: StoriesHash;
-    initialExpanded?: ExpandedState;
-    rootIds: string[];
-    selectedStoryId: string | null;
-    onSelectStoryId: (storyId: string) => void;
+  refId: string;
+  data: StoriesHash;
+  initialExpanded?: ExpandedState;
+  rootIds: string[];
+  selectedStoryId: string | null;
+  onSelectStoryId: (storyId: string) => void;
 }
-declare const useExpanded: ({ refId, data, initialExpanded, rootIds, selectedStoryId, }: ExpandedProps) => [ExpandedState, Dispatch<ExpandAction>];
-
+declare const useExpanded: ({
+  refId,
+  data,
+  initialExpanded,
+  rootIds,
+  selectedStoryId
+}: ExpandedProps) => [ExpandedState, Dispatch<ExpandAction>];
+//#endregion
+//#region src/hooks/useLastViewed.d.ts
 declare const useLastViewed: (selection: Selection) => {
-    getLastViewed: () => any[];
-    clearLastViewed: () => void;
+  getLastViewed: () => StoryRef[];
+  clearLastViewed: () => void;
 };
-
-declare const useStoreBooleanState: (key: string, defaultValue: boolean) => ReturnType<typeof useState<boolean>>;
+//#endregion
+//#region src/hooks/useStoreState.d.ts
+declare const useStoreBooleanState: (key: string, defaultValue: boolean) => [boolean, Dispatch<SetStateAction<boolean>>];
 declare const useStoreNumberState: (key: string, defaultValue: number) => [number, (value: number | ((prev: number) => number)) => void];
-
-export { Button, ButtonIcon, type ButtonProps, ButtonText, type CombinedDataset, type Dataset, type ExpandAction, type ExpandType, type ExpandedProps, type ExpandedState, type GetSearchItemProps, type Highlight, type HighlightRange, type HighlightRanges, IconButton, type Item, type ItemRef, LayoutProvider, type RefType, type Refs, type SBUI, type SearchChildrenFn, type SearchItem, type SearchResult, type SearchResultProps, type Selection, type Storage, StorageProvider, type StoryRef, createId, cycle, get, getAncestorIds, getDescendantIds, getParent, getParents, getPath, getStateType, intersect, isAncestor, isExpandType, isStoryHoistable, merge, noArrayMerge, prevent, removeNoiseFromName, searchItem, startCase, transformStoryIndexToStoriesHash, transformStoryIndexV2toV3, transformStoryIndexV3toV4, transformStoryIndexV4toV5, useExpanded, useLastViewed, useLayout, useStorage, useStoreBooleanState, useStoreNumberState, useStyle };
+//#endregion
+export { Button, ButtonIcon, ButtonProps, ButtonText, CombinedDataset, Dataset, ExpandAction, ExpandType, ExpandedProps, ExpandedState, GetSearchItemProps, Highlight, HighlightRange, HighlightRanges, IconButton, Item, ItemRef, LayoutProvider, RefType, Refs, SBUI, SearchChildrenFn, SearchItem, SearchResult, SearchResultProps, Selection, Storage, StorageProvider, StoryRef, createId, cycle, get, getAncestorIds, getDescendantIds, getParent, getParents, getPath, getStateType, intersect, isAncestor, isExpandType, isStoryHoistable, merge, noArrayMerge, prevent, removeNoiseFromName, searchItem, startCase, transformStoryIndexToStoriesHash, transformStoryIndexV2toV3, transformStoryIndexV3toV4, transformStoryIndexV4toV5, useExpanded, useLastViewed, useLayout, useStorage, useStoreBooleanState, useStoreNumberState, useStyle };