@storybook/core-events

  • Version 8.0.8
  • Published
  • 152 kB
  • 1 dependency
  • MIT license

Install

npm i @storybook/core-events
yarn add @storybook/core-events
pnpm add @storybook/core-events

Overview

Event names used in storybook core

Index

Variables

Interfaces

Enums

Type Aliases

Variables

variable CHANNEL_CREATED

const CHANNEL_CREATED: events;

    variable CHANNEL_WS_DISCONNECT

    const CHANNEL_WS_DISCONNECT: events;

      variable CONFIG_ERROR

      const CONFIG_ERROR: events;

        variable CURRENT_STORY_WAS_SET

        const CURRENT_STORY_WAS_SET: events;

          variable DOCS_PREPARED

          const DOCS_PREPARED: events;

            variable DOCS_RENDERED

            const DOCS_RENDERED: events;

              variable FORCE_RE_RENDER

              const FORCE_RE_RENDER: events;

                variable FORCE_REMOUNT

                const FORCE_REMOUNT: events;

                  variable GLOBALS_UPDATED

                  const GLOBALS_UPDATED: events;
                    const NAVIGATE_URL: events;

                      variable PLAY_FUNCTION_THREW_EXCEPTION

                      const PLAY_FUNCTION_THREW_EXCEPTION: events;

                        variable PRELOAD_ENTRIES

                        const PRELOAD_ENTRIES: events;

                          variable PREVIEW_BUILDER_PROGRESS

                          const PREVIEW_BUILDER_PROGRESS: events;

                            variable PREVIEW_KEYDOWN

                            const PREVIEW_KEYDOWN: events;

                              variable REGISTER_SUBSCRIPTION

                              const REGISTER_SUBSCRIPTION: events;

                                variable REQUEST_WHATS_NEW_DATA

                                const REQUEST_WHATS_NEW_DATA: events;

                                  variable RESET_STORY_ARGS

                                  const RESET_STORY_ARGS: events;

                                    variable RESULT_WHATS_NEW_DATA

                                    const RESULT_WHATS_NEW_DATA: events;

                                      variable SELECT_STORY

                                      const SELECT_STORY: events;

                                        variable SET_CONFIG

                                        const SET_CONFIG: events;

                                          variable SET_CURRENT_STORY

                                          const SET_CURRENT_STORY: events;

                                            variable SET_GLOBALS

                                            const SET_GLOBALS: events;

                                              variable SET_INDEX

                                              const SET_INDEX: events;

                                                variable SET_STORIES

                                                const SET_STORIES: events;

                                                  variable SET_WHATS_NEW_CACHE

                                                  const SET_WHATS_NEW_CACHE: events;

                                                    variable SHARED_STATE_CHANGED

                                                    const SHARED_STATE_CHANGED: events;

                                                      variable SHARED_STATE_SET

                                                      const SHARED_STATE_SET: events;

                                                        variable STORIES_COLLAPSE_ALL

                                                        const STORIES_COLLAPSE_ALL: events;

                                                          variable STORIES_EXPAND_ALL

                                                          const STORIES_EXPAND_ALL: events;

                                                            variable STORY_ARGS_UPDATED

                                                            const STORY_ARGS_UPDATED: events;

                                                              variable STORY_CHANGED

                                                              const STORY_CHANGED: events;

                                                                variable STORY_ERRORED

                                                                const STORY_ERRORED: events;

                                                                  variable STORY_INDEX_INVALIDATED

                                                                  const STORY_INDEX_INVALIDATED: events;

                                                                    variable STORY_MISSING

                                                                    const STORY_MISSING: events;

                                                                      variable STORY_PREPARED

                                                                      const STORY_PREPARED: events;

                                                                        variable STORY_RENDER_PHASE_CHANGED

                                                                        const STORY_RENDER_PHASE_CHANGED: events;

                                                                          variable STORY_RENDERED

                                                                          const STORY_RENDERED: events;

                                                                            variable STORY_SPECIFIED

                                                                            const STORY_SPECIFIED: events;

                                                                              variable STORY_THREW_EXCEPTION

                                                                              const STORY_THREW_EXCEPTION: events;

                                                                                variable STORY_UNCHANGED

                                                                                const STORY_UNCHANGED: events;

                                                                                  variable TELEMETRY_ERROR

                                                                                  const TELEMETRY_ERROR: events;

                                                                                    variable TOGGLE_WHATS_NEW_NOTIFICATIONS

                                                                                    const TOGGLE_WHATS_NEW_NOTIFICATIONS: events;

                                                                                      variable UNHANDLED_ERRORS_WHILE_PLAYING

                                                                                      const UNHANDLED_ERRORS_WHILE_PLAYING: events;

                                                                                        variable UPDATE_GLOBALS

                                                                                        const UPDATE_GLOBALS: events;

                                                                                          variable UPDATE_QUERY_PARAMS

                                                                                          const UPDATE_QUERY_PARAMS: events;

                                                                                            variable UPDATE_STORY_ARGS

                                                                                            const UPDATE_STORY_ARGS: events;

                                                                                              Interfaces

                                                                                              interface WhatsNewCache

                                                                                              interface WhatsNewCache {}

                                                                                                property lastDismissedPost

                                                                                                lastDismissedPost?: string;

                                                                                                  property lastReadPost

                                                                                                  lastReadPost?: string;

                                                                                                    Enums

                                                                                                    enum events

                                                                                                    enum events {
                                                                                                    CHANNEL_WS_DISCONNECT = 'channelWSDisconnect',
                                                                                                    CHANNEL_CREATED = 'channelCreated',
                                                                                                    CONFIG_ERROR = 'configError',
                                                                                                    STORY_INDEX_INVALIDATED = 'storyIndexInvalidated',
                                                                                                    STORY_SPECIFIED = 'storySpecified',
                                                                                                    SET_CONFIG = 'setConfig',
                                                                                                    SET_STORIES = 'setStories',
                                                                                                    SET_INDEX = 'setIndex',
                                                                                                    SET_CURRENT_STORY = 'setCurrentStory',
                                                                                                    CURRENT_STORY_WAS_SET = 'currentStoryWasSet',
                                                                                                    FORCE_RE_RENDER = 'forceReRender',
                                                                                                    FORCE_REMOUNT = 'forceRemount',
                                                                                                    PRELOAD_ENTRIES = 'preloadStories',
                                                                                                    STORY_PREPARED = 'storyPrepared',
                                                                                                    DOCS_PREPARED = 'docsPrepared',
                                                                                                    STORY_CHANGED = 'storyChanged',
                                                                                                    STORY_UNCHANGED = 'storyUnchanged',
                                                                                                    STORY_RENDERED = 'storyRendered',
                                                                                                    STORY_MISSING = 'storyMissing',
                                                                                                    STORY_ERRORED = 'storyErrored',
                                                                                                    STORY_THREW_EXCEPTION = 'storyThrewException',
                                                                                                    STORY_RENDER_PHASE_CHANGED = 'storyRenderPhaseChanged',
                                                                                                    PLAY_FUNCTION_THREW_EXCEPTION = 'playFunctionThrewException',
                                                                                                    UNHANDLED_ERRORS_WHILE_PLAYING = 'unhandledErrorsWhilePlaying',
                                                                                                    UPDATE_STORY_ARGS = 'updateStoryArgs',
                                                                                                    STORY_ARGS_UPDATED = 'storyArgsUpdated',
                                                                                                    RESET_STORY_ARGS = 'resetStoryArgs',
                                                                                                    SET_GLOBALS = 'setGlobals',
                                                                                                    UPDATE_GLOBALS = 'updateGlobals',
                                                                                                    GLOBALS_UPDATED = 'globalsUpdated',
                                                                                                    REGISTER_SUBSCRIPTION = 'registerSubscription',
                                                                                                    PREVIEW_KEYDOWN = 'previewKeydown',
                                                                                                    PREVIEW_BUILDER_PROGRESS = 'preview_builder_progress',
                                                                                                    SELECT_STORY = 'selectStory',
                                                                                                    STORIES_COLLAPSE_ALL = 'storiesCollapseAll',
                                                                                                    STORIES_EXPAND_ALL = 'storiesExpandAll',
                                                                                                    DOCS_RENDERED = 'docsRendered',
                                                                                                    SHARED_STATE_CHANGED = 'sharedStateChanged',
                                                                                                    SHARED_STATE_SET = 'sharedStateSet',
                                                                                                    NAVIGATE_URL = 'navigateUrl',
                                                                                                    UPDATE_QUERY_PARAMS = 'updateQueryParams',
                                                                                                    REQUEST_WHATS_NEW_DATA = 'requestWhatsNewData',
                                                                                                    RESULT_WHATS_NEW_DATA = 'resultWhatsNewData',
                                                                                                    SET_WHATS_NEW_CACHE = 'setWhatsNewCache',
                                                                                                    TOGGLE_WHATS_NEW_NOTIFICATIONS = 'toggleWhatsNewNotifications',
                                                                                                    TELEMETRY_ERROR = 'telemetryError',
                                                                                                    }

                                                                                                      member CHANNEL_CREATED

                                                                                                      CHANNEL_CREATED = 'channelCreated'

                                                                                                        member CHANNEL_WS_DISCONNECT

                                                                                                        CHANNEL_WS_DISCONNECT = 'channelWSDisconnect'

                                                                                                          member CONFIG_ERROR

                                                                                                          CONFIG_ERROR = 'configError'

                                                                                                            member CURRENT_STORY_WAS_SET

                                                                                                            CURRENT_STORY_WAS_SET = 'currentStoryWasSet'

                                                                                                              member DOCS_PREPARED

                                                                                                              DOCS_PREPARED = 'docsPrepared'

                                                                                                                member DOCS_RENDERED

                                                                                                                DOCS_RENDERED = 'docsRendered'

                                                                                                                  member FORCE_RE_RENDER

                                                                                                                  FORCE_RE_RENDER = 'forceReRender'

                                                                                                                    member FORCE_REMOUNT

                                                                                                                    FORCE_REMOUNT = 'forceRemount'

                                                                                                                      member GLOBALS_UPDATED

                                                                                                                      GLOBALS_UPDATED = 'globalsUpdated'

                                                                                                                        member NAVIGATE_URL

                                                                                                                        NAVIGATE_URL = 'navigateUrl'

                                                                                                                          member PLAY_FUNCTION_THREW_EXCEPTION

                                                                                                                          PLAY_FUNCTION_THREW_EXCEPTION = 'playFunctionThrewException'

                                                                                                                            member PRELOAD_ENTRIES

                                                                                                                            PRELOAD_ENTRIES = 'preloadStories'

                                                                                                                              member PREVIEW_BUILDER_PROGRESS

                                                                                                                              PREVIEW_BUILDER_PROGRESS = 'preview_builder_progress'

                                                                                                                                member PREVIEW_KEYDOWN

                                                                                                                                PREVIEW_KEYDOWN = 'previewKeydown'

                                                                                                                                  member REGISTER_SUBSCRIPTION

                                                                                                                                  REGISTER_SUBSCRIPTION = 'registerSubscription'

                                                                                                                                    member REQUEST_WHATS_NEW_DATA

                                                                                                                                    REQUEST_WHATS_NEW_DATA = 'requestWhatsNewData'

                                                                                                                                      member RESET_STORY_ARGS

                                                                                                                                      RESET_STORY_ARGS = 'resetStoryArgs'

                                                                                                                                        member RESULT_WHATS_NEW_DATA

                                                                                                                                        RESULT_WHATS_NEW_DATA = 'resultWhatsNewData'

                                                                                                                                          member SELECT_STORY

                                                                                                                                          SELECT_STORY = 'selectStory'

                                                                                                                                            member SET_CONFIG

                                                                                                                                            SET_CONFIG = 'setConfig'

                                                                                                                                              member SET_CURRENT_STORY

                                                                                                                                              SET_CURRENT_STORY = 'setCurrentStory'

                                                                                                                                                member SET_GLOBALS

                                                                                                                                                SET_GLOBALS = 'setGlobals'

                                                                                                                                                  member SET_INDEX

                                                                                                                                                  SET_INDEX = 'setIndex'

                                                                                                                                                    member SET_STORIES

                                                                                                                                                    SET_STORIES = 'setStories'

                                                                                                                                                      member SET_WHATS_NEW_CACHE

                                                                                                                                                      SET_WHATS_NEW_CACHE = 'setWhatsNewCache'

                                                                                                                                                        member SHARED_STATE_CHANGED

                                                                                                                                                        SHARED_STATE_CHANGED = 'sharedStateChanged'

                                                                                                                                                          member SHARED_STATE_SET

                                                                                                                                                          SHARED_STATE_SET = 'sharedStateSet'

                                                                                                                                                            member STORIES_COLLAPSE_ALL

                                                                                                                                                            STORIES_COLLAPSE_ALL = 'storiesCollapseAll'

                                                                                                                                                              member STORIES_EXPAND_ALL

                                                                                                                                                              STORIES_EXPAND_ALL = 'storiesExpandAll'

                                                                                                                                                                member STORY_ARGS_UPDATED

                                                                                                                                                                STORY_ARGS_UPDATED = 'storyArgsUpdated'

                                                                                                                                                                  member STORY_CHANGED

                                                                                                                                                                  STORY_CHANGED = 'storyChanged'

                                                                                                                                                                    member STORY_ERRORED

                                                                                                                                                                    STORY_ERRORED = 'storyErrored'

                                                                                                                                                                      member STORY_INDEX_INVALIDATED

                                                                                                                                                                      STORY_INDEX_INVALIDATED = 'storyIndexInvalidated'

                                                                                                                                                                        member STORY_MISSING

                                                                                                                                                                        STORY_MISSING = 'storyMissing'

                                                                                                                                                                          member STORY_PREPARED

                                                                                                                                                                          STORY_PREPARED = 'storyPrepared'

                                                                                                                                                                            member STORY_RENDER_PHASE_CHANGED

                                                                                                                                                                            STORY_RENDER_PHASE_CHANGED = 'storyRenderPhaseChanged'

                                                                                                                                                                              member STORY_RENDERED

                                                                                                                                                                              STORY_RENDERED = 'storyRendered'

                                                                                                                                                                                member STORY_SPECIFIED

                                                                                                                                                                                STORY_SPECIFIED = 'storySpecified'

                                                                                                                                                                                  member STORY_THREW_EXCEPTION

                                                                                                                                                                                  STORY_THREW_EXCEPTION = 'storyThrewException'

                                                                                                                                                                                    member STORY_UNCHANGED

                                                                                                                                                                                    STORY_UNCHANGED = 'storyUnchanged'

                                                                                                                                                                                      member TELEMETRY_ERROR

                                                                                                                                                                                      TELEMETRY_ERROR = 'telemetryError'

                                                                                                                                                                                        member TOGGLE_WHATS_NEW_NOTIFICATIONS

                                                                                                                                                                                        TOGGLE_WHATS_NEW_NOTIFICATIONS = 'toggleWhatsNewNotifications'

                                                                                                                                                                                          member UNHANDLED_ERRORS_WHILE_PLAYING

                                                                                                                                                                                          UNHANDLED_ERRORS_WHILE_PLAYING = 'unhandledErrorsWhilePlaying'

                                                                                                                                                                                            member UPDATE_GLOBALS

                                                                                                                                                                                            UPDATE_GLOBALS = 'updateGlobals'

                                                                                                                                                                                              member UPDATE_QUERY_PARAMS

                                                                                                                                                                                              UPDATE_QUERY_PARAMS = 'updateQueryParams'

                                                                                                                                                                                                member UPDATE_STORY_ARGS

                                                                                                                                                                                                UPDATE_STORY_ARGS = 'updateStoryArgs'

                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                  type WhatsNewData

                                                                                                                                                                                                  type WhatsNewData =
                                                                                                                                                                                                  | {
                                                                                                                                                                                                  status: 'SUCCESS';
                                                                                                                                                                                                  title: string;
                                                                                                                                                                                                  url: string;
                                                                                                                                                                                                  blogUrl?: string;
                                                                                                                                                                                                  publishedAt: string;
                                                                                                                                                                                                  excerpt: string;
                                                                                                                                                                                                  postIsRead: boolean;
                                                                                                                                                                                                  showNotification: boolean;
                                                                                                                                                                                                  disableWhatsNewNotifications: boolean;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  | {
                                                                                                                                                                                                  status: 'ERROR';
                                                                                                                                                                                                  };

                                                                                                                                                                                                    Package Files (1)

                                                                                                                                                                                                    Dependencies (1)

                                                                                                                                                                                                    Dev Dependencies (2)

                                                                                                                                                                                                    Peer Dependencies (0)

                                                                                                                                                                                                    No peer dependencies.

                                                                                                                                                                                                    Badge

                                                                                                                                                                                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                                                                                                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/core-events.

                                                                                                                                                                                                    • Markdown
                                                                                                                                                                                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@storybook/core-events)
                                                                                                                                                                                                    • HTML
                                                                                                                                                                                                      <a href="https://www.jsdocs.io/package/@storybook/core-events"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>