{"id":20235066,"url":"https://github.com/paranatural/panopticon","last_synced_at":"2025-04-10T18:52:34.877Z","repository":{"id":193547232,"uuid":"396748783","full_name":"paranatural/panopticon","owner":"paranatural","description":"React component playground as React component","archived":false,"fork":false,"pushed_at":"2023-11-05T03:13:34.000Z","size":130,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T16:39:51.238Z","etag":null,"topics":["component-playground","gallery","panopticon","paranatural","playground","react","reactjs","storybook"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paranatural.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":"contributing.md","funding":null,"license":"license.md","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-08-16T10:48:02.000Z","updated_at":"2023-11-03T23:52:31.000Z","dependencies_parsed_at":"2023-11-04T00:24:45.225Z","dependency_job_id":null,"html_url":"https://github.com/paranatural/panopticon","commit_stats":null,"previous_names":["unordinarity/panopticon","paranatural/panopticon"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paranatural%2Fpanopticon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paranatural%2Fpanopticon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paranatural%2Fpanopticon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paranatural%2Fpanopticon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paranatural","download_url":"https://codeload.github.com/paranatural/panopticon/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248274767,"owners_count":21076468,"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":["component-playground","gallery","panopticon","paranatural","playground","react","reactjs","storybook"],"created_at":"2024-11-14T08:14:32.804Z","updated_at":"2025-04-10T18:52:34.859Z","avatar_url":"https://github.com/paranatural.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align='center'\u003e\n    \u003cpicture\u003e\n        \u003csource media='(prefers-color-scheme: dark)' srcset='./.github/panopticon-logo-light-160.png' /\u003e\n        \u003csource media='(prefers-color-scheme: light)' srcset='./.github/panopticon-logo-dark-160.png' /\u003e\n        \u003cimg src='./.github/panopticon-logo-dark-160.png' /\u003e\n    \u003c/picture\u003e\n\u003c/div\u003e\n\n# ⬡ Panopticon\n\nReact component playground as React component\n\n# ⬡ Motivation/Promise\n\nPanopticon works/feels like any other React component and doesn't force/lead you to write a lot of configs/stories just for setting up a component playground. That's why it keeps consistent/unified build workflow/pipeline for your application.\n\n# ⬡ Features\n\n# ⬡ Installation\n\n```shell\nyarn add panopticon-core panopticon-stdlib\n```\n\n```shell\nnpm i panopticon-core panopticon-stdlib\n```\n\n```shell\npnpm add panopticon-core panopticon-stdlib\n```\n\n# ⬡ Usage/Utilizing/Enjoyment\n\n```typescript jsx\nimport React, { FunctionComponent, ButtonHTMLAttributes } from 'react'\nimport { createRoot } from 'react-dom/client'\nimport { Gallery } from 'panopticon-core'\nimport { BooleanCheckbox } from 'panopticon-stdlib'\n\n// imagine this is your component\nconst Button: FunctionComponent\u003cButtonHTMLAttributes\u003cHTMLButtonElement\u003e\u003e =\n  ({ ...props }) =\u003e \u003cbutton {...props} /\u003e\n\n// make an exhibit from component\n// and use some knobs to experiment with it\nconst buttonExhibit: Exhibit\u003cButtonHTMLAttributes\u003cHTMLButtonElement\u003e\u003e = {\n  component: Button,\n  props: {\n    disabled: BooleanCheckbox,\n  }\n}\n\n// create a page from list of exhibits\nconst PanopticonPage = () =\u003e (\n  \u003cGallery\n    exhibits={[\n      buttonExhibit\n    ]}\n  /\u003e\n)\n\n// and render page\ncreateRoot(document.querySelector('#react'))\n  .render(\u003cPanopticonPage /\u003e)\n```\n\nSimple, right? No configs or build pipelines/plugins, just components.\n\nCheck out [other examples](./examples/usage) and [router integration guides](./examples/integrations).\n\n# ⬡ API\n\n[`panopticon-core`](packages/panopticon/readme.md#-api)\n\nGallery and IFrame components, type definitions\n\n[`panopticon-stdlib`](./packages/stdlib/readme.md#-api)\n\nCollection of knobs for common/general purposes\n\n# ⬡ Contribution\n\nFeel free to open an issue/discussion with request/report, but ensure you read/follow [Contributor Covenant Code of Conduct](code_of_conduct.md)\n\n# ⬡ Development/History\n\n[Changelog/Past/Versions](changelog.md)\n\n[Roadmap/Future](roadmap.md)\n\n# ⬡ Legal info\n\nProject licensed under [MIT License](license.md). [What it means](https://choosealicense.com/licenses/mit/)\n\n# ⬡ Brand/Look\n\nProject name, logo, visual design and writing style heavily inspired by [Control game](https://www.remedygames.com/games/control/) (made by [Remedy Entertainment](https://www.remedygames.com/))\n\n[shields-fsd-image]: https://img.shields.io/badge/Feature--Sliced-Design-F92672?logoWidth=32\u0026style=flat-square\u0026logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9Ii0xIC0xIDI0IDI0Ij4KICA8cGF0aCBmaWxsPSIjZmZmIiBkPSJNMCAwaDIzdjJIMFYwWm0wIDNoMjN2MkgwVjNabTAgM2g4djJIMFY2Wm0wIDNoMjN2MkgwVjlabTAgM2gyMHYySDB2LTJabTAgM2g4djJIMHYtMlptMTUgMGgydjJoLTJ2LTJaTTAgMThoOHYySDB2LTJabTAgM2g4djJIMHYtMloiLz4KPC9zdmc+Cg==\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparanatural%2Fpanopticon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparanatural%2Fpanopticon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparanatural%2Fpanopticon/lists"}