{"_id":"@dropsy-ui/storybook-addon-docs-stencil","_rev":"4-04dbd93016c8b15132a4903daf15b71e","name":"@dropsy-ui/storybook-addon-docs-stencil","dist-tags":{"latest":"10.0.2"},"versions":{"9.0.0":{"name":"@dropsy-ui/storybook-addon-docs-stencil","version":"9.0.0","author":{"name":"Andrew St. Jean","email":"andrew@dropsy-ui.com"},"license":"MIT","_id":"@dropsy-ui/storybook-addon-docs-stencil@9.0.0","maintainers":[{"name":"astjean12","email":"astjean12@gmail.com"}],"contributors":[{"name":"life4aiur"}],"homepage":"https://github.com/dropsy-ui/storybook-addon-docs-stencil#readme","bugs":{"url":"https://github.com/dropsy-ui/storybook-addon-docs-stencil/issues"},"dist":{"shasum":"2c0cd1de7e81113eb86dc510e479813ba538aad8","tarball":"https://registry.npmjs.org/@dropsy-ui/storybook-addon-docs-stencil/-/storybook-addon-docs-stencil-9.0.0.tgz","fileCount":28,"integrity":"sha512-RDZWgJJt5jXjDNV6imH6+16cE7RQti9rUr481Nuod4KmA4PkyMLYEzqLZZ9AyvDBCEgxOarLUr4PZVx6NHbFhg==","signatures":[{"sig":"MEUCIQCejtUImpScKPGvNkz1n19zH+o8ZOtyi9l/FRmRIfde2wIgSNNJUgOAgyH8/qnPPJ/zYE5iEVyK26jFRdz7Jcr4+7A=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":138686},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","bundler":{"nodeEntries":["src/preset.ts"],"exportEntries":["src/extract-arg-types.ts","src/render.ts","src/index.ts"],"managerEntries":["src/entry-preview-docs.ts"],"previewEntries":[]},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"},"./preset":"./dist/preset.cjs","./package.json":"./package.json"},"scripts":{"lint":"eslint . --report-unused-disable-directives","test":"echo \"Error: no test specified\" && exit 1","build":"npm run lint && tsup","start":"tsup --watch","format":"npm run prettier:fix && npm run lint:fix","prepare":"husky","lint:fix":"npm run lint -- --fix","prettier":"prettier ./src --no-error-on-unmatched-pattern --check","prettier:fix":"npm run prettier -- --write"},"_npmUser":{"name":"astjean12","email":"astjean12@gmail.com"},"storybook":{"icon":"https://raw.githubusercontent.com/ionic-team/stencil/main/stencil-logo.png","displayName":"Stencil docs and controls","supportedFrameworks":["web-components","html"]},"repository":{"url":"git+https://github.com/dropsy-ui/storybook-addon-docs-stencil.git","type":"git"},"_npmVersion":"11.6.4","description":"Converts stencil.js JsonDoc to storybook ArgTypes","directories":{},"_nodeVersion":"24.11.1","_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.5","vite":"^6.0.7","husky":"^9.1.7","eslint":"^9.18.0","prettier":"^3.4.2","storybook":"^9.0.0","typescript":"^5.7.3","@types/node":"^25.5.0","lint-staged":"^15.3.0","@types/eslint__js":"^8.42.3","typescript-eslint":"^8.19.1"},"peerDependencies":{"storybook":"^9.0.0"},"_npmOperationalInternal":{"tmp":"tmp/storybook-addon-docs-stencil_9.0.0_1774359117601_0.5889460570650256","host":"s3://npm-registry-packages-npm-production"}},"10.0.0":{"name":"@dropsy-ui/storybook-addon-docs-stencil","version":"10.0.0","keywords":["stencil","storybook","storybook-addon"],"author":{"name":"Andrew St. Jean","email":"andrew@dropsy-ui.com"},"license":"MIT","_id":"@dropsy-ui/storybook-addon-docs-stencil@10.0.0","maintainers":[{"name":"astjean12","email":"andrew@dropsy-ui.com"}],"contributors":[{"name":"life4aiur"}],"homepage":"https://github.com/dropsy-ui/storybook-addon-docs-stencil#readme","bugs":{"url":"https://github.com/dropsy-ui/storybook-addon-docs-stencil/issues"},"dist":{"shasum":"649ee206b70d5c00f5bcccb77237f75c4e701d59","tarball":"https://registry.npmjs.org/@dropsy-ui/storybook-addon-docs-stencil/-/storybook-addon-docs-stencil-10.0.0.tgz","fileCount":10,"integrity":"sha512-Rs8E3z9zSoum19o/e3UrHS0tehj5UlLvKantHx/WEVb1LC3BE1VBJZQlj1am1FIM5cxRz5wjitz5wSm1ByX7EQ==","signatures":[{"sig":"MEUCIFO1VGKLFfDrYJC4TbroR34ASQF2M9Jh5qzzreoMoEGmAiEA50t21pvcvLFE6r4CkXjt2QDmNHJkpKEQAodpRaOO2PI=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":22699},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","bundler":{"nodeEntries":["src/preset.ts"],"exportEntries":[],"managerEntries":[],"previewEntries":["src/index.ts","src/preview.ts"]},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./preset":"./dist/preset.js","./preview":{"types":"./dist/preview.d.ts","default":"./dist/preview.js"},"./package.json":"./package.json"},"gitHead":"c42b9967033aee752ebe28b57abb44c108e2ae37","scripts":{"lint":"eslint . --report-unused-disable-directives","test":"echo \"Error: no test specified\" && exit 1","build":"npm run lint && tsup","start":"tsup --watch","format":"npm run prettier:fix && npm run lint:fix","prepare":"husky","release":"npm run build && changeset publish","lint:fix":"npm run lint -- --fix","prettier":"prettier ./src --no-error-on-unmatched-pattern --check","changeset":"changeset","prettier:fix":"npm run prettier -- --write","version-packages":"changeset version"},"_npmUser":{"name":"astjean12","email":"andrew@dropsy-ui.com"},"storybook":{"icon":"https://raw.githubusercontent.com/ionic-team/stencil/main/stencil-logo.png","displayName":"Stencil docs and controls","supportedFrameworks":["web-components","html"]},"repository":{"url":"git+https://github.com/dropsy-ui/storybook-addon-docs-stencil.git","type":"git"},"_npmVersion":"11.6.4","description":"Converts stencil.js JsonDoc to storybook ArgTypes","directories":{},"_nodeVersion":"24.11.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.5","vite":"^6.0.7","husky":"^9.1.7","eslint":"^9.18.0","prettier":"^3.4.2","storybook":"^10.0.0","typescript":"^5.7.3","@types/node":"^25.5.0","lint-staged":"^15.3.0","@changesets/cli":"^2.30.0","@types/eslint__js":"^8.42.3","typescript-eslint":"^8.19.1"},"peerDependencies":{"storybook":"^10.0.0"},"_npmOperationalInternal":{"tmp":"tmp/storybook-addon-docs-stencil_10.0.0_1774466493835_0.20216426317182257","host":"s3://npm-registry-packages-npm-production"}},"10.0.1":{"name":"@dropsy-ui/storybook-addon-docs-stencil","version":"10.0.1","keywords":["stencil","storybook","storybook-addon"],"author":{"name":"Andrew St. Jean","email":"andrew@dropsy-ui.com"},"license":"MIT","_id":"@dropsy-ui/storybook-addon-docs-stencil@10.0.1","maintainers":[{"name":"astjean12","email":"andrew@dropsy-ui.com"}],"contributors":[{"name":"life4aiur"}],"homepage":"https://github.com/dropsy-ui/storybook-addon-docs-stencil#readme","bugs":{"url":"https://github.com/dropsy-ui/storybook-addon-docs-stencil/issues"},"dist":{"shasum":"e1dad2bc8fed6ae4f043590dac8c006a0557512b","tarball":"https://registry.npmjs.org/@dropsy-ui/storybook-addon-docs-stencil/-/storybook-addon-docs-stencil-10.0.1.tgz","fileCount":11,"integrity":"sha512-WgUkFMML1HqsPjsnGtEslyXHLD1Tt48zbxN4kv/g+HPEGgZ0ciRuFejq1uXIPUk1voauzzfYNqY0GF8U4ru1Bw==","signatures":[{"sig":"MEQCIEoRmoZj/KnQO2IsvivcUwSfJFrxgM9fPV+47uLUh6wBAiAZKmVGaj7u/p1zkceozZBjoqFgtpVHdcZKk0aOTTgDhA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":31256},"main":"dist/index.js","type":"module","types":"./dist/index.d.ts","bundler":{"nodeEntries":["src/preset.ts"],"exportEntries":[],"managerEntries":[],"previewEntries":["src/index.ts","src/preview.ts"]},"exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./preset":"./dist/preset.js","./preview":{"types":"./dist/preview.d.ts","default":"./dist/preview.js"},"./package.json":"./package.json"},"gitHead":"4144deaf9df2b1b9bbe8667a37d46202bcd33f5e","scripts":{"lint":"eslint . --report-unused-disable-directives","test":"echo \"Error: no test specified\" && exit 1","build":"npm run lint && tsup","start":"tsup --watch","format":"npm run prettier:fix && npm run lint:fix","prepare":"husky","release":"npm run build && changeset publish","lint:fix":"npm run lint -- --fix","prettier":"prettier ./src --no-error-on-unmatched-pattern --check","changeset":"changeset","prettier:fix":"npm run prettier -- --write","version-packages":"changeset version"},"_npmUser":{"name":"astjean12","email":"andrew@dropsy-ui.com"},"storybook":{"icon":"https://raw.githubusercontent.com/dropsy-ui/storybook-addon-docs-stencil/refs/heads/main/dropsy-ui.png","displayName":"Stencil component documentation","supportedFrameworks":["web-components","html"]},"repository":{"url":"git+https://github.com/dropsy-ui/storybook-addon-docs-stencil.git","type":"git"},"_npmVersion":"11.2.0","description":"Storybook addon for Stencil component documentation","directories":{},"_nodeVersion":"24.11.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.3.5","vite":"^6.0.7","husky":"^9.1.7","eslint":"^9.18.0","prettier":"^3.4.2","storybook":"^10.0.0","typescript":"^5.7.3","@types/node":"^25.5.0","lint-staged":"^15.3.0","@changesets/cli":"^2.30.0","@types/eslint__js":"^8.42.3","typescript-eslint":"^8.19.1"},"peerDependencies":{"storybook":"^10.0.0"},"_npmOperationalInternal":{"tmp":"tmp/storybook-addon-docs-stencil_10.0.1_1774534597981_0.856220221041395","host":"s3://npm-registry-packages-npm-production"}},"10.0.2":{"name":"@dropsy-ui/storybook-addon-docs-stencil","version":"10.0.2","description":"Storybook addon for Stencil component documentation","main":"dist/index.js","type":"module","exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"},"./preview":{"types":"./dist/preview.d.ts","default":"./dist/preview.js"},"./preset":"./dist/preset.js","./package.json":"./package.json"},"scripts":{"start":"tsup --watch","build":"npm run lint && tsup","changeset":"changeset","version-packages":"changeset version","release":"npm run build && changeset publish","format":"npm run prettier:fix && npm run lint:fix","lint":"eslint . --report-unused-disable-directives","lint:fix":"npm run lint -- --fix","prettier":"prettier ./src --no-error-on-unmatched-pattern --check","prettier:fix":"npm run prettier -- --write","test":"echo \"Error: no test specified\" && exit 1","prepare":"husky"},"repository":{"type":"git","url":"git+https://github.com/dropsy-ui/storybook-addon-docs-stencil.git"},"bugs":{"url":"https://github.com/dropsy-ui/storybook-addon-docs-stencil/issues"},"homepage":"https://github.com/dropsy-ui/storybook-addon-docs-stencil#readme","author":{"name":"Andrew St. Jean","email":"andrew@dropsy-ui.com"},"contributors":[{"name":"life4aiur"}],"license":"MIT","devDependencies":{"@changesets/cli":"^2.30.0","@types/eslint__js":"^8.42.3","@types/node":"^25.5.0","eslint":"^9.18.0","husky":"^9.1.7","lint-staged":"^15.3.0","prettier":"^3.4.2","storybook":"^10.0.0","tsup":"^8.3.5","typescript":"^5.7.3","typescript-eslint":"^8.19.1","vite":"^6.0.7"},"peerDependencies":{"storybook":"^10.0.0"},"publishConfig":{"access":"public"},"bundler":{"exportEntries":[],"managerEntries":[],"previewEntries":["src/index.ts","src/preview.ts"],"nodeEntries":["src/preset.ts"]},"storybook":{"displayName":"Stencil component documentation","supportedFrameworks":["web-components","html"],"icon":"https://raw.githubusercontent.com/dropsy-ui/storybook-addon-docs-stencil/refs/heads/main/dropsy-ui.png"},"keywords":["storybook-addon","stencil","storybook"],"_id":"@dropsy-ui/storybook-addon-docs-stencil@10.0.2","gitHead":"9df3b917f5e1963a4002b04a86cbd5d60b534681","types":"./dist/index.d.ts","_nodeVersion":"24.11.1","_npmVersion":"11.2.0","dist":{"integrity":"sha512-07cDO70okMANvfKN3+CIxTopDct8cqc/VhzQHagNOsvhppObtnMB9EuW6fxFKgg1O5RAYb6NPu2quIiqn1TgUw==","shasum":"b5b70b328b45a4dfdec6c44c9b9180206b70d083","tarball":"https://registry.npmjs.org/@dropsy-ui/storybook-addon-docs-stencil/-/storybook-addon-docs-stencil-10.0.2.tgz","fileCount":11,"unpackedSize":31256,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCICkHHqAnq2nXBHa7m4gvcrWYiPfteJNNKZSxqxh/eD/xAiEA5rxRj5FpEHNaCUhJgvxqxEDvtotcAR8V5jDOkYSFhLg="}]},"_npmUser":{"name":"astjean12","email":"andrew@dropsy-ui.com"},"directories":{},"maintainers":[{"name":"astjean12","email":"andrew@dropsy-ui.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/storybook-addon-docs-stencil_10.0.2_1774535963112_0.19422316863276023"},"_hasShrinkwrap":false}},"time":{"created":"2026-03-24T13:31:57.517Z","modified":"2026-03-26T14:39:23.364Z","9.0.0":"2026-03-24T13:31:57.747Z","10.0.0":"2026-03-25T19:21:34.004Z","10.0.1":"2026-03-26T14:16:38.117Z","10.0.2":"2026-03-26T14:39:23.252Z"},"bugs":{"url":"https://github.com/dropsy-ui/storybook-addon-docs-stencil/issues"},"author":{"name":"Andrew St. Jean","email":"andrew@dropsy-ui.com"},"license":"MIT","homepage":"https://github.com/dropsy-ui/storybook-addon-docs-stencil#readme","keywords":["storybook-addon","stencil","storybook"],"repository":{"type":"git","url":"git+https://github.com/dropsy-ui/storybook-addon-docs-stencil.git"},"description":"Storybook addon for Stencil component documentation","contributors":[{"name":"life4aiur"}],"maintainers":[{"name":"astjean12","email":"andrew@dropsy-ui.com"}],"readme":"# storybook-addon-docs-stencil\n\n## Attribution\n\nThis package is community-maintained work based on prior Storybook + Stencil community effort.\n\n- Original project: https://github.com/pixtron/storybook-addon-docs-stencil\n\nThis repository was reinitialized independently (not a GitHub fork), and it preserves upstream attribution and MIT license notices.\n\nFor additional provenance details, see `NOTICE`.\n\nConverts stencil.js doc json derived from stencils output target\n[`docs-json`](https://stenciljs.com/docs/docs-json) to storybook\n[`ArgTypes`](https://storybook.js.org/docs/react/api/argtypes).\n\nWith this addon activated\n\n- Storybook will render basic controls for properties [Controls](https://storybook.js.org/docs/react/essentials/controls).\n- Storybook will auto generate documentation for Props, Events, Methods, Slots, Shadow Parts and Custom Properties.\n- Storybook doc page will contain stencils component documentation (readme.md or inline)\n\n## Installation\n\n```bash\nnpm i -D @dropsy-ui/storybook-addon-docs-stencil\n```\n\n## Versioning\n\nThis package follows Storybook major versions:\n\n- `9.x` supports Storybook `9.x`\n- `10.x` will support Storybook `10.x`\n\nThis means breaking compatibility with a new Storybook major is released as a new addon major.\n\n## Releasing\n\nRelease and contribution guidelines live in `CONTRIBUTING.md`.\n\n## Usage\n\n### Configure stencil to generate docs-json at build time.\n\n```js\n// stencil.config.ts\n\nimport { Config } from '@stencil/core';\n\nexport const config: Config = {\n  outputTargets: [\n    {\n      type: 'docs-json',\n      file: 'path/to/docs.json'\n    }\n  ]\n};\n```\n\n### Configure Storybook\n\n```js\n//.storybook/main.js\n\nmodule.exports = {\n  addons: [\n    '@storybook/addon-essentials',\n    '@dropsy-ui/storybook-addon-docs-stencil',\n  ],\n};\n```\n\n```js\n//.storybook/preview.js\n\nimport { setStencilDocJson } from '@dropsy-ui/storybook-addon-docs-stencil';\nimport docJson from 'path/to/docs.json';\nif (docJson) setStencilDocJson(docJson);\n\nexport const parameters = {\n  controls: { hideNoControlsWarning: true },\n};\n```\n\n### Configure the argTypes extractor\n\n```js\n//.storybook/preview.js\n\nimport { extractArgTypesFactory } from '@dropsy-ui/storybook-addon-docs-stencil';\n\n/** @type { import('@dropsy-ui/storybook-addon-docs-stencil').ExtractArgTypesOptions } */\nconst options = {\n  excludeCategories: 'properties',\n  controlsFor: 'attributes',\n  eventNaming: 'jsx',\n};\n\nexport const parameters = {\n  docs: {\n    extractArgTypes: extractArgTypesFactory(options),\n  },\n};\n```\n\n#### ExtractArgTypesOptions\n\n- `excludeCategories: Category[]`: categories to exclude from argTypes and docs (default: `['attributes]`).\n- `controlsFor: 'attributes' | 'properties'`: for wich category to render controls.\n- `eventNaming: 'native' | 'jsx'`: naming of the arg key for events (default: 'native'). If jsx the args can be spread `<my-component {...args} />` when using JSX to render stories.\n\n### Default render method\n\nWhen using @storybook/web-components or @storybook/html as renderer args and actions do not get bound automatically. This addon includes an optional default renderer that works out of the box\n\n```js\n//.storybook/preview.js\n\nimport {\n  extractArgTypesFactory,\n  stencilRender,\n} from '@dropsy-ui/storybook-addon-docs-stencil';\n\n/** @type { import('@storybook/web-components').Preview } */\nconst preview = {\n  render: stencilRender(),\n};\n\nexport default preview;\n```\n\n`stencilRender` can be configured by these options:\n\n- `eventNaming: 'native' | 'jsx'`: use the same naming used in ExtractArgTypesOptions (default: 'native)\n- `bindEvents: boolean`: whether events/actions should be bound (default: true)\n\neg:\n\n```js\nstencilRender({ bindEvents: false });\n```\n\n### Component documentation\n\n#### readme.md\n\nIf not already created by stencil create `src/components/my-component/readme.md`\nIf the line `<!-- Auto Generated Below -->` is not present, stencil will ignore this file.\n\n```md\nEverything above this line will be included in storybook\n\n<!-- Auto Generated Below -->\n```\n\n#### inline documentation\n\n```ts\n// src/components/my-component/my-component.tsx`\n\n/**\n * Everything written here will be included, if readme.md is not present.\n */\n@Component({\n  tag: 'my-component',\n  styleUrl: 'my-component.css',\n  shadow: true,\n})\n```\n\nIf you prefere the inline documentation over the readme, see [issue #15](https://github.com/dropsy-ui/storybook-addon-docs-stencil/issues/15#issuecomment-2387147999).\n\n#### Troubleshooting\n\n##### Hint your component in your stories\n\n```ts\n// your-story.ts\n\nexport default {\n  title: 'My Component',\n  component: 'my-component',\n};\n```\n\n### Breaking Changes in v7\n\n- attributes and properties are now shown as own categories, before both where visible under \"props\" with some inconsistency in naming (dashCase vs camelCase). Use `excludeCategories` to configure which categories are shown.\n- removed configuration `dashCase` properties and attributes are now shown in single sections. Use `controlsFor` and `excludeCategories` instead of `dashCase`.\n","readmeFilename":"README.md"}