UNPKG

wix-storybook-utils

Version:

Utilities for automated component documentation within Storybook

90 lines 4.39 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.storyPage = exports.demo = exports.includedComponents = exports.doDont = exports.example = exports.plugin = exports.title = exports.divider = exports.mdx = exports.table = exports.tabs = exports.columns = exports.testkit = exports.playground = exports.api = exports.tab = exports.importExample = exports.header = exports.description = exports.code = void 0; var tslib_1 = require("tslib"); var story_section_1 = require("../typings/story-section"); // functions exported in this file are used as builders for `sections` array in story config. they are typed // abstractions for consumer, so that they don't need to write all details manually and can also leverage some // autocomplete var base = function (config) { return (tslib_1.__assign({ pretitle: '', title: '', subtitle: '', hidden: false }, config)); }; var code = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Code }, (typeof config === 'string' ? { source: config } : config))); }; exports.code = code; var description = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Description }, (typeof config === 'string' ? { text: config } : config))); }; exports.description = description; var header = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Header }, config)); }; exports.header = header; var importExample = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.ImportExample, title: 'Import' }, (typeof config === 'string' ? { source: config } : config))); }; exports.importExample = importExample; var tab = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Tab, sections: [] }, config)); }; exports.tab = tab; var api = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Api }, config)); }; exports.api = api; var playground = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Playground }, config)); }; exports.playground = playground; var testkit = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Testkit }, config)); }; exports.testkit = testkit; var columns = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Columns }, (Array.isArray(config) ? { items: config } : config))); }; exports.columns = columns; var tabs = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Tabs }, (Array.isArray(config) ? { tabs: config } : config))); }; exports.tabs = tabs; var table = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Table }, (Array.isArray(config) ? { rows: config } : config))); }; exports.table = table; var mdx = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.MDX }, config)); }; exports.mdx = mdx; var divider = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Divider }, config)); }; exports.divider = divider; var title = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Title }, (typeof config === 'string' ? { title: config } : config))); }; exports.title = title; var plugin = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Plugin }, config)); }; exports.plugin = plugin; var example = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Example, compact: true }, config)); }; exports.example = example; var doDont = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.DoDont }, config)); }; exports.doDont = doDont; var includedComponents = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.IncludedComponents }, config)); }; exports.includedComponents = includedComponents; var demo = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.Demo }, config)); }; exports.demo = demo; var storyPage = function (config) { return base(tslib_1.__assign({ type: story_section_1.SectionType.StoryPage }, config)); }; exports.storyPage = storyPage; //# sourceMappingURL=index.js.map