core-client.d.ts 3.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. import { C as ClientApi } from './ClientApi-24d2bfd0.js';
  2. export { S as StoryStore } from './StoryStore-f7424ddf.js';
  3. import { Renderer, ProjectAnnotations, ArgsStoryFn } from '@storybook/types';
  4. import 'synchronous-promise';
  5. import './hooks-655fa363.js';
  6. interface CoreClient_RendererImplementation<TRenderer extends Renderer> {
  7. /**
  8. * A function that applies decorators to a story.
  9. * @template TRenderer The type of renderer used by the Storybook client API.
  10. * @type {ProjectAnnotations<TRenderer>['applyDecorators']}
  11. */
  12. decorateStory?: ProjectAnnotations<TRenderer>['applyDecorators'];
  13. /**
  14. * A function that renders a story with args.
  15. * @template TRenderer The type of renderer used by the Storybook client API.
  16. * @type {ArgsStoryFn<TRenderer>}
  17. */
  18. render?: ArgsStoryFn<TRenderer>;
  19. }
  20. interface CoreClient_ClientAPIFacade {
  21. /**
  22. * The old way of adding stories at runtime.
  23. * @deprecated This method is deprecated and will be removed in a future version.
  24. */
  25. storiesOf: (...args: any[]) => never;
  26. /**
  27. * The old way of retrieving the list of stories at runtime.
  28. * @deprecated This method is deprecated and will be removed in a future version.
  29. */
  30. raw: (...args: any[]) => never;
  31. }
  32. interface CoreClient_StartReturnValue<TRenderer extends Renderer> {
  33. /**
  34. * Forces a re-render of all stories in the Storybook preview.
  35. * This function emits the `FORCE_RE_RENDER` event to the Storybook channel.
  36. * @deprecated This method is deprecated and will be removed in a future version.
  37. * @returns {void}
  38. */
  39. forceReRender: () => void;
  40. /**
  41. * The old way of setting up storybook with runtime configuration.
  42. * @deprecated This method is deprecated and will be removed in a future version.
  43. * @returns {void}
  44. */
  45. configure: any;
  46. /**
  47. * @deprecated This property is deprecated and will be removed in a future version.
  48. * @type {ClientApi<TRenderer> | CoreClient_ClientAPIFacade}
  49. */
  50. clientApi: ClientApi<TRenderer> | CoreClient_ClientAPIFacade;
  51. }
  52. /**
  53. * Initializes the Storybook preview API.
  54. * @template TRenderer The type of renderer used by the Storybook client API.
  55. * @param {ProjectAnnotations<TRenderer>['renderToCanvas']} renderToCanvas A function that renders a story to a canvas.
  56. * @param {CoreClient_RendererImplementation<TRenderer>} [options] Optional configuration options for the renderer implementation.
  57. * @param {ProjectAnnotations<TRenderer>['applyDecorators']} [options.decorateStory] A function that applies decorators to a story.
  58. * @param {ArgsStoryFn<TRenderer>} [options.render] A function that renders a story with arguments.
  59. * @returns {CoreClient_StartReturnValue<TRenderer>} An object containing functions and objects related to the Storybook preview API.
  60. */
  61. declare function start<TRenderer extends Renderer>(renderToCanvas: ProjectAnnotations<TRenderer>['renderToCanvas'], { decorateStory, render }?: CoreClient_RendererImplementation<TRenderer>): CoreClient_StartReturnValue<TRenderer>;
  62. export { ClientApi, start };