@aussieljk/forkbook 0.0.1-4 → 0.0.1-6

package/dist/{chunk-DIz17UEJ.d.ts → chunk-CzmZhVrn.d.ts}

@@ -2,7 +2,7 @@ import { A as Queries, C as GetServiceOptions, D as MatchingOutputSchemas, G as
 import { a as RenderData } from "./chunk-DoIGKY33.js";
 import { s as ThemeVars$1 } from "./chunk-BGkgZp-H.js";
 import { p as Channel$1 } from "./chunk-BXLImeLy.js";
-import { X as StrictArgTypes$3, s as Args$3 } from "./chunk-B2xylxt5.js";
+import { X as StrictArgTypes$3, s as Args$3 } from "./chunk-DROZ9oel.js";
 import { t as Options$3 } from "./chunk-C6PAgHLT.js";
 import { a as StoryStore, i as RenderType, n as StoryRender, r as Render, s as ReporterAPI, u as StorySpecifier } from "./chunk-Bpi2tz-6.js";
 import { AfterEach as AfterEach$1, AnnotatedStoryFn as AnnotatedStoryFn$1, ArgTypes as ArgTypes$2, ArgTypesEnhancer, Args, Args as Args$2, ArgsEnhancer, ArgsFromMeta as ArgsFromMeta$1, ArgsStoryFn as ArgsStoryFn$1, BaseAnnotations as BaseAnnotations$1, BeforeAll, BeforeEach, Canvas as Canvas$1, CleanupCallback, CleanupCallback as CleanupCallback$1, ComponentAnnotations as ComponentAnnotations$1, ComponentId, ComponentTitle as ComponentTitle$1, Conditional as Conditional$1, DecoratorApplicator as DecoratorApplicator$1, DecoratorFunction as DecoratorFunction$2, GlobalTypes as GlobalTypes$1, Globals, Globals as Globals$2, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn as LegacyStoryAnnotationsOrFn$1, LegacyStoryFn as LegacyStoryFn$1, LoaderFunction as LoaderFunction$1, Meta, Parameters as Parameters$2, PartialStoryFn as PartialStoryFn$1, PlayFunction, PlayFunctionContext, ProjectAnnotations, ProjectAnnotations as BaseProjectAnnotations, Renderer, Renderer as Renderer$2, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType as SBType$1, SBUnionType, SeparatorOptions, StepFunction, StepLabel, StepRunner as StepRunner$1, Story, StoryAnnotations as StoryAnnotations$1, StoryAnnotationsOrFn as StoryAnnotationsOrFn$1, StoryContext, StoryContext as StoryContext$2, StoryContextForEnhancers as StoryContextForEnhancers$1, StoryContextForLoaders, StoryContextForRender, StoryContextUpdate as StoryContextUpdate$1, StoryFn, StoryId, StoryId as StoryId$2, StoryIdentifier, StoryKind as StoryKind$1, StoryName as StoryName$1, StrictArgTypes, StrictArgTypes as StrictArgTypes$2, StrictArgs as StrictArgs$1, StrictInputType, Tag, Tag as Tag$2, TestFunction as TestFunction$1, ViewMode, toId } from "@aussieljk/forkbook/internal/csf";
@@ -10900,6 +10900,10 @@ type API_PanelPositions$1 = 'bottom' | 'right';
 type API_ActiveTabsType = 'sidebar' | 'canvas' | 'addons';
 interface API_SidebarOptions$1<API = any> {
   showRoots?: boolean;
+  /** Show the type icon (group, component, docs, story) before each sidebar item. Default: false. */
+  showIcons?: boolean;
+  /** Expand every group and component in the sidebar when Forkbook opens. Default: true. */
+  expandAll?: boolean;
   filters?: Record<string, API_FilterFunction$1>;
   collapsedRoots?: string[];
   renderAriaLabel?: (item: API_HashEntry$1, api: API, context?: {
@@ -12035,6 +12039,34 @@ interface SelectionStore {
   setQueryParams(queryParams: Record<PropertyKey, unknown>): void;
 }
 //#endregion
+//#region .dts-emit/code/core/src/preview-api/modules/preview-web/InfiniteDocs.d.ts
+/**
+ * Infinite scroll for docs pages. When the reader gets near the end of a docs page, the next docs
+ * entry (in sidebar order) renders below it. The page at the top of the view is sent to the
+ * manager with `DOCS_PAGE_IN_VIEW`, so the sidebar and the URL follow it without a new render.
+ *
+ * On by default. The `docs.infiniteScroll: false` parameter turns it off.
+ */
+declare class InfiniteDocs<TRenderer extends Renderer$1> {
+  private channel;
+  private store;
+  private renderStoryToElement;
+  private callbacks;
+  private renders;
+  private container?;
+  private sentinelObserver?;
+  private pageObserver?;
+  private lastId?;
+  private inViewId?;
+  private loading;
+  constructor(channel: Channel, store: StoryStore<TRenderer>, renderStoryToElement: DocsContextProps$1<TRenderer>['renderStoryToElement'], callbacks: (id: StoryId$1) => RenderContextCallbacks<TRenderer>);
+  /** Starts after the main docs page `entry` rendered into `docsRoot`. */
+  start(entry: IndexEntry, docsRoot: HTMLElement): void;
+  private loadNext;
+  /** Removes the pages below the main page. */
+  stop(): void;
+}
+//#endregion
 //#region .dts-emit/code/core/src/preview-api/modules/preview-web/View.d.ts
 interface View<TStorybookRoot> {
   prepareForStory(story: PreparedStory<any>, options?: {
@@ -12070,6 +12102,8 @@ declare class PreviewWithSelection<TRenderer extends Renderer$1> extends Preview
   view: View<TRenderer['canvasElement']>;
   currentSelection?: Selection;
   currentRender?: PossibleRender<TRenderer>;
+  /** The docs pages below the selected docs page (`docs.infiniteScroll`). */
+  infiniteDocs?: InfiniteDocs<TRenderer>;
   constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations$1<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
   setupListeners(): void;
   onNavigateUrl(url: string): void;

package/dist/{chunk-B2xylxt5.d.ts → chunk-DROZ9oel.d.ts}

@@ -3,278 +3,10 @@ import { t as Simplify } from "./chunk-FjDVzZTj.js";
 import { r as BackgroundTypes } from "./chunk-Dm-iHJ-s.js";
 import { i as HighlightTypes } from "./chunk-DDd8BhTY.js";
 import { l as ViewportTypes } from "./chunk-DgzPaTw9.js";
-import React, { ComponentProps } from "react";
 import { StorybookTypes } from "@aussieljk/forkbook/internal/types";
 import { BoundFunctions, queries } from "@testing-library/dom";
 import { userEvent } from "@testing-library/user-event";
 
-//#region .dts-emit/code/core/src/components/components/icon/icon.d.ts
-type IconType = keyof typeof icons;
-interface IconsProps extends ComponentProps<'svg'> {
-  icon: IconType;
-  useSymbol?: boolean;
-  onClick?: () => void;
-  __suppressDeprecationWarning?: boolean;
-}
-declare const icons: {
-  readonly user: 'UserIcon';
-  readonly useralt: 'UserAltIcon';
-  readonly useradd: 'UserAddIcon';
-  readonly users: 'UsersIcon';
-  readonly profile: 'ProfileIcon';
-  readonly facehappy: 'FaceHappyIcon';
-  readonly faceneutral: 'FaceNeutralIcon';
-  readonly facesad: 'FaceSadIcon';
-  readonly accessibility: 'AccessibilityIcon';
-  readonly accessibilityalt: 'AccessibilityAltIcon';
-  readonly accessibilityignored: 'AccessibilityIgnoredIcon';
-  readonly arrowup: 'ChevronUpIcon';
-  readonly arrowdown: 'ChevronDownIcon';
-  readonly arrowleft: 'ChevronLeftIcon';
-  readonly arrowright: 'ChevronRightIcon';
-  readonly arrowupalt: 'ArrowUpIcon';
-  readonly arrowdownalt: 'ArrowDownIcon';
-  readonly arrowleftalt: 'ArrowLeftIcon';
-  readonly arrowrightalt: 'ArrowRightIcon';
-  readonly arrowtopleft: 'ArrowTopLeftIcon';
-  readonly arrowtopright: 'ArrowTopRightIcon';
-  readonly arrowbottomleft: 'ArrowBottomLeftIcon';
-  readonly arrowbottomright: 'ArrowBottomRightIcon';
-  readonly arrowsolidup: 'ArrowSolidUpIcon';
-  readonly arrowsoliddown: 'ArrowSolidDownIcon';
-  readonly arrowsolidleft: 'ArrowSolidLeftIcon';
-  readonly arrowsolidright: 'ArrowSolidRightIcon';
-  readonly chevronsmallup: 'ChevronSmallUpIcon';
-  readonly chevronsmalldown: 'ChevronSmallDownIcon';
-  readonly chevronsmallleft: 'ChevronSmallLeftIcon';
-  readonly chevronsmallright: 'ChevronSmallRightIcon';
-  readonly expandalt: 'ExpandAltIcon';
-  readonly collapse: 'CollapseIcon';
-  readonly expand: 'ExpandIcon';
-  readonly unfold: 'UnfoldIcon';
-  readonly transfer: 'TransferIcon';
-  readonly redirect: 'RedirectIcon';
-  readonly jumpto: 'JumpToIcon';
-  readonly popout: 'PopOutIcon';
-  readonly undo: 'UndoIcon';
-  readonly reply: 'ReplyIcon';
-  readonly sync: 'SyncIcon';
-  readonly upload: 'UploadIcon';
-  readonly download: 'DownloadIcon';
-  readonly save: 'SaveIcon';
-  readonly back: 'BackIcon';
-  readonly proceed: 'ProceedIcon';
-  readonly refresh: 'RefreshIcon';
-  readonly globe: 'GlobeIcon';
-  readonly compass: 'CompassIcon';
-  readonly direction: 'DirectionIcon';
-  readonly location: 'LocationIcon';
-  readonly pin: 'PinIcon';
-  readonly time: 'TimeIcon';
-  readonly dashboard: 'DashboardIcon';
-  readonly timer: 'TimerIcon';
-  readonly home: 'HomeIcon';
-  readonly admin: 'AdminIcon';
-  readonly info: 'InfoIcon';
-  readonly question: 'QuestionIcon';
-  readonly support: 'SupportIcon';
-  readonly bug: 'BugIcon';
-  readonly alert: 'AlertIcon';
-  readonly alertalt: 'AlertAltIcon';
-  readonly email: 'EmailIcon';
-  readonly phone: 'PhoneIcon';
-  readonly link: 'LinkIcon';
-  readonly unlink: 'LinkBrokenIcon';
-  readonly bell: 'BellIcon';
-  readonly rss: 'RSSIcon';
-  readonly sharealt: 'ShareAltIcon';
-  readonly share: 'ShareIcon';
-  readonly circle: 'CircleIcon';
-  readonly circlehollow: 'CircleHollowIcon';
-  readonly diamond: 'DiamondIcon';
-  readonly bookmarkhollow: 'BookmarkHollowIcon';
-  readonly bookmark: 'BookmarkIcon';
-  readonly hearthollow: 'HeartHollowIcon';
-  readonly heart: 'HeartIcon';
-  readonly starhollow: 'StarHollowIcon';
-  readonly star: 'StarIcon';
-  readonly certificate: 'CertificateIcon';
-  readonly verified: 'VerifiedIcon';
-  readonly thumbsup: 'ThumbsUpIcon';
-  readonly shield: 'ShieldIcon';
-  readonly basket: 'BasketIcon';
-  readonly beaker: 'BeakerIcon';
-  readonly hourglass: 'HourglassIcon';
-  readonly flag: 'FlagIcon';
-  readonly gift: 'GiftIcon';
-  readonly sticker: 'StickerIcon';
-  readonly cloudhollow: 'CloudHollowIcon';
-  readonly cloud: 'CloudIcon';
-  readonly edit: 'EditIcon';
-  readonly editor: 'EditorIcon';
-  readonly cog: 'CogIcon';
-  readonly nut: 'NutIcon';
-  readonly wrench: 'WrenchIcon';
-  readonly wand: 'WandIcon';
-  readonly ellipsis: 'EllipsisIcon';
-  readonly check: 'CheckIcon';
-  readonly checklist: 'ChecklistIcon';
-  readonly form: 'FormIcon';
-  readonly batchdeny: 'BatchDenyIcon';
-  readonly batchaccept: 'BatchAcceptIcon';
-  readonly controls: 'ControlsIcon';
-  readonly plus: 'PlusIcon';
-  readonly closeAlt: 'CloseAltIcon';
-  readonly cross: 'CrossIcon';
-  readonly trash: 'TrashIcon';
-  readonly pinalt: 'PinAltIcon';
-  readonly unpin: 'UnpinIcon';
-  readonly add: 'AddIcon';
-  readonly subtract: 'SubtractIcon';
-  readonly close: 'CloseIcon';
-  readonly delete: 'DeleteIcon';
-  readonly passed: 'PassedIcon';
-  readonly changed: 'ChangedIcon';
-  readonly failed: 'FailedIcon';
-  readonly status: 'StatusIcon';
-  readonly statuspass: 'StatusPassIcon';
-  readonly statusfail: 'StatusFailIcon';
-  readonly statuswarn: 'StatusWarnIcon';
-  readonly statusnew: 'StatusAddIcon';
-  readonly clear: 'ClearIcon';
-  readonly sweep: 'SweepIcon';
-  readonly comment: 'CommentIcon';
-  readonly commentadd: 'CommentAddIcon';
-  readonly requestchange: 'RequestChangeIcon';
-  readonly comments: 'CommentsIcon';
-  readonly chat: 'ChatIcon';
-  readonly lock: 'LockIcon';
-  readonly unlock: 'UnlockIcon';
-  readonly key: 'KeyIcon';
-  readonly command: 'CommandIcon';
-  readonly outbox: 'OutboxIcon';
-  readonly credit: 'CreditIcon';
-  readonly button: 'ButtonIcon';
-  readonly type: 'TypeIcon';
-  readonly pointerdefault: 'PointerDefaultIcon';
-  readonly pointerhand: 'PointerHandIcon';
-  readonly browser: 'BrowserIcon';
-  readonly tablet: 'TabletIcon';
-  readonly mobile: 'MobileIcon';
-  readonly watch: 'WatchIcon';
-  readonly sidebar: 'SidebarIcon';
-  readonly sidebaralt: 'SidebarAltIcon';
-  readonly sidebaralttoggle: 'SidebarAltToggleIcon';
-  readonly sidebartoggle: 'SidebarToggleIcon';
-  readonly bottombar: 'BottomBarIcon';
-  readonly bottombartoggle: 'BottomBarToggleIcon';
-  readonly cpu: 'CPUIcon';
-  readonly database: 'DatabaseIcon';
-  readonly memory: 'MemoryIcon';
-  readonly structure: 'StructureIcon';
-  readonly box: 'BoxIcon';
-  readonly power: 'PowerIcon';
-  readonly photo: 'PhotoIcon';
-  readonly component: 'ComponentIcon';
-  readonly grid: 'GridIcon';
-  readonly gridalt: 'GridAltIcon';
-  readonly outline: 'OutlineIcon';
-  readonly photodrag: 'PhotoDragIcon';
-  readonly photostabilize: 'PhotoStabilizeIcon';
-  readonly drag: 'DragIcon';
-  readonly search: 'SearchIcon';
-  readonly zoom: 'ZoomIcon';
-  readonly zoomout: 'ZoomOutIcon';
-  readonly zoomreset: 'ZoomResetIcon';
-  readonly eye: 'EyeIcon';
-  readonly eyeclose: 'EyeCloseIcon';
-  readonly lightning: 'LightningIcon';
-  readonly lightningoff: 'LightningOffIcon';
-  readonly contrast: 'ContrastIcon';
-  readonly contrastignored: 'ContrastIgnoredIcon';
-  readonly switchalt: 'SwitchAltIcon';
-  readonly mirror: 'MirrorIcon';
-  readonly grow: 'GrowIcon';
-  readonly paintbrush: 'PaintBrushIcon';
-  readonly paintbrushalt: 'PaintBrushAltIcon';
-  readonly ruler: 'RulerIcon';
-  readonly stop: 'StopIcon';
-  readonly camera: 'CameraIcon';
-  readonly camerastabilize: 'CameraStabilizeIcon';
-  readonly video: 'VideoIcon';
-  readonly speaker: 'SpeakerIcon';
-  readonly play: 'PlayIcon';
-  readonly playback: 'PlayBackIcon';
-  readonly playnext: 'PlayNextIcon';
-  readonly playhollow: 'PlayHollowIcon';
-  readonly playallhollow: 'PlayAllHollowIcon';
-  readonly rewind: 'RewindIcon';
-  readonly fastforward: 'FastForwardIcon';
-  readonly stopalt: 'StopAltIcon';
-  readonly stopalthollow: 'StopAltHollowIcon';
-  readonly sidebyside: 'SideBySideIcon';
-  readonly stacked: 'StackedIcon';
-  readonly sun: 'SunIcon';
-  readonly moon: 'MoonIcon';
-  readonly book: 'BookIcon';
-  readonly document: 'DocumentIcon';
-  readonly copy: 'CopyIcon';
-  readonly category: 'CategoryIcon';
-  readonly folder: 'FolderIcon';
-  readonly files: 'FilesIcon';
-  readonly print: 'PrintIcon';
-  readonly graphline: 'GraphLineIcon';
-  readonly calendar: 'CalendarIcon';
-  readonly graphbar: 'GraphBarIcon';
-  readonly menu: 'MenuIcon';
-  readonly menualt: 'MenuIcon';
-  readonly filter: 'FilterIcon';
-  readonly sortup: 'SortUpIcon';
-  readonly sortdown: 'SortDownIcon';
-  readonly docchart: 'DocChartIcon';
-  readonly doclist: 'DocListIcon';
-  readonly markup: 'MarkupIcon';
-  readonly bold: 'BoldIcon';
-  readonly italic: 'ItalicIcon';
-  readonly alignleft: 'AlignLeftIcon';
-  readonly alignright: 'AlignRightIcon';
-  readonly paperclip: 'PaperClipIcon';
-  readonly listordered: 'ListOrderedIcon';
-  readonly listunordered: 'ListUnorderedIcon';
-  readonly paragraph: 'ParagraphIcon';
-  readonly markdown: 'MarkdownIcon';
-  readonly repository: 'RepoIcon';
-  readonly commit: 'CommitIcon';
-  readonly branch: 'BranchIcon';
-  readonly pullrequest: 'PullRequestIcon';
-  readonly merge: 'MergeIcon';
-  readonly apple: 'AppleIcon';
-  readonly linux: 'LinuxIcon';
-  readonly ubuntu: 'UbuntuIcon';
-  readonly windows: 'WindowsIcon';
-  readonly storybook: 'StorybookIcon';
-  readonly azuredevops: 'AzureDevOpsIcon';
-  readonly bitbucket: 'BitbucketIcon';
-  readonly chrome: 'ChromeIcon';
-  readonly chromatic: 'ChromaticIcon';
-  readonly componentdriven: 'ComponentDrivenIcon';
-  readonly discord: 'DiscordIcon';
-  readonly facebook: 'FacebookIcon';
-  readonly figma: 'FigmaIcon';
-  readonly gdrive: 'GDriveIcon';
-  readonly github: 'GithubIcon';
-  readonly gitlab: 'GitlabIcon';
-  readonly google: 'GoogleIcon';
-  readonly graphql: 'GraphqlIcon';
-  readonly linkedin: 'LinkedinIcon';
-  readonly medium: 'MediumIcon';
-  readonly redux: 'ReduxIcon';
-  readonly twitter: 'TwitterIcon';
-  readonly x: 'XIcon';
-  readonly youtube: 'YoutubeIcon';
-  readonly vscode: 'VSCodeIcon';
-};
-//#endregion
 //#region .dts-emit/code/core/src/toolbar/types.d.ts
 type ToolbarShortcutType = 'next' | 'previous' | 'reset';
 type ToolbarItemType = 'item' | 'reset';
@@ -285,7 +17,8 @@ interface ToolbarShortcutConfig {
 type ToolbarShortcuts = Record<ToolbarShortcutType, ToolbarShortcutConfig>;
 interface ToolbarItem {
   value?: string;
-  icon?: IconsProps['icon'];
+  /** The name of an icon, for example `'circlehollow'` (see the `icons` map in icon.tsx) */
+  icon?: string;
   right?: string;
   title?: string;
   hideIcon?: boolean;
@@ -294,8 +27,11 @@ interface ToolbarItem {
 interface NormalizedToolbarConfig {
   /** The label to show for this toolbar item */
   title?: string;
-  /** Choose an icon to show for this toolbar item */
-  icon?: IconsProps['icon'];
+  /**
+   * Choose an icon to show for this toolbar item, by name. The type is `string`, not the list of
+   * names, so the public types do not depend on the icon package.
+   */
+  icon?: string;
   /** Set to true to prevent default update of icon to match any present selected items icon */
   preventDynamicIcon?: boolean;
   items: ToolbarItem[];