Skip to content

API Reference / @gtkx/storybook / @gtkx/storybook/explorer / startStorybook

Function: startStorybook() ​

startStorybook(options): StorybookSession

Defined in: packages/storybook/src/explorer.ts:24

Starts a native explorer and returns the handle used to load stories and stop it.

Parameters ​

options ​

applicationId ​

string

Gio application identifier assigned to the explorer application.

initialStoryId? ​

string

Story to select once it is loaded, such as the one a restarted explorer was showing.

onStorySelected? ​

(id) => void

Called with the identifier of each story the explorer selects.

Returns ​

StorybookSession