{"id":15022511,"url":"https://github.com/matmalkowski/docz-knobs","last_synced_at":"2025-05-02T08:30:44.103Z","repository":{"id":36812239,"uuid":"178242176","full_name":"matmalkowski/docz-knobs","owner":"matmalkowski","description":"🎛 Knobs component to demo your React creations with Docz","archived":false,"fork":false,"pushed_at":"2022-12-10T17:16:59.000Z","size":1443,"stargazers_count":4,"open_issues_count":38,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-18T16:38:06.282Z","etag":null,"topics":["documentation","docz","docz-plugin","knobs","mdx","react"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/matmalkowski.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-28T16:27:27.000Z","updated_at":"2020-04-08T19:15:31.000Z","dependencies_parsed_at":"2023-01-17T05:15:36.235Z","dependency_job_id":null,"html_url":"https://github.com/matmalkowski/docz-knobs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matmalkowski%2Fdocz-knobs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matmalkowski%2Fdocz-knobs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matmalkowski%2Fdocz-knobs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/matmalkowski%2Fdocz-knobs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/matmalkowski","download_url":"https://codeload.github.com/matmalkowski/docz-knobs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252008709,"owners_count":21679625,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","docz","docz-plugin","knobs","mdx","react"],"created_at":"2024-09-24T19:58:03.222Z","updated_at":"2025-05-02T08:30:43.531Z","avatar_url":"https://github.com/matmalkowski.png","language":"TypeScript","readme":"[![NPM](https://img.shields.io/npm/v/docz-knobs.svg)](https://www.npmjs.com/package/docz-knobs)\n[![build](https://travis-ci.org/matmalkowski/docz-knobs.svg?branch=master)](https://travis-ci.org/matmalkowski/docz-)\n\n# 🎛 docz-knobs\n\n\u003e Knobs component set to use with your docz based documents!\n\n[Docz](https://www.docz.site/) is a great `MDX` based framework for documenting your libraries and projects. With this simple `Knobs` component it enables even more features as in renders helper knobs/switches for your component to make the demo even more rebust and accessible! is a\n\n## 🛠 Install\n\n```bash\nyarn add docz-knobs\n\nnpm install --save docz-knobs\n```\n\n## 📟 Usage\n\nSimply wrap your component in MDX file with the `Knobs` component.\n\n```tsx\nimport * as React from \"react\";\nimport Knobs from \"docz-knobs\";\n\nimport { Button } from \"./Button\";\n\n\u003cKnobs\n  options={{\n    scale: [\"small\", \"normal\", \"big\"],\n    kind: [\"primary\", \"secondary\", \"cancel\", \"dark\", \"gray\"]\n  }}\n\u003e\n  \u003cButton\u003eClick me\u003c/Button\u003e\n\u003c/Knobs\u003e;\n```\n\n![Example Image](https://i.imgur.com/yrAUDKC.png)\n\nFor complex types you need to specify available values with options prop.\n\n## License\n\nMIT © [matmalkowski](https://github.com/matmalkowski)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatmalkowski%2Fdocz-knobs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmatmalkowski%2Fdocz-knobs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmatmalkowski%2Fdocz-knobs/lists"}