seek-oss/playroom: designing in JSX with your own components, and what the config makes you decide
Design with JSX, powered by your own component library.
At a glance
- What is it?
- Playroom is a TypeScript tool from SEEK that puts a live JSX editor on top of your component library and builds it into a standalone bundle. This look covers the config options, the component export contract, snippets, and the release history.
- Who is it for?
- Playroom fits a team that already maintains a React-style component library and wants designers and engineers to mock up with real components, deployed next to the design system docs. It does nothing for a project without a component library to export, so check that first, then pick your own port and sandbox settings.
- Can I use it commercially?
- Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
- Is it still maintained?
- Yes. The repository last received commits 17 days ago.
- What is it written in?
- Mainly TypeScript, according to GitHub's language statistics.
Answers come from the project's GitHub data, last synced on November 15, 2026, and from our analysis. They are not legal advice.
Star history
- seek-oss/playroom4,594 ★ · +12
| Repository | 2026-09-23 | 2026-11-15 |
|---|---|---|
| seek-oss/playroom | 4.6k | 4.6k |
12 Stars in the last 53 days, measured from the daily GitHub snapshot. Compare with other projects
Editorial analysis
Designs are JSX written against your real components, rendered across themes and widths at once
Playroom describes itself as a way to simultaneously design across a variety of themes and screen sizes, powered by JSX and your own component library. The pitch is a zero-install, code-oriented design environment that builds into a standalone bundle, which you can deploy alongside your existing design system documentation. The stated uses are iterating on designs in the final medium, making quick mock-ups and interactive prototypes with real code, exercising how flexible your design system is, and sharing work by copying the URL.
The demo list shows who runs it in public: Braid Design System, Cubes, Mesh Design System, Mística Design System, Shopify Polaris, and the Agriculture Design System. Several are marked Themed. The consequence is that Playroom shows only what your library can render. If a component is missing, inconsistent, or badly themed, the design environment exposes that rather than hiding it, which is useful for evaluating a system but not a substitute for one.
Setup is one dev dependency, two scripts and a playroom.config.js with two required fields
Installation is a dev dependency.
$ npm install --save-dev playroomThen two package.json scripts call the CLI.
{
"scripts": {
"playroom:start": "playroom start",
"playroom:build": "playroom build"
}
}A playroom.config.js sits in the project root. The first two fields in the example, `components: './src/components'` and `outputPath: './dist/playroom'`, are the ones not labelled optional: where your components come from, and where the built bundle lands. Everything after the Optional comment can be left out.
Run `npm run playroom:start` for a local development server, and `npm run playroom:build` to build assets for production. Because the build output is a static directory, deploying it is a matter of copying it to wherever your design system docs live, and the baseUrl option exists for serving it from a subpath such as /playroom/.
Only what your components file exports can appear in the editor
The components file is expected to export a single object or a series of named exports. The example re-exports a default export as Text and a named export as Button from relative paths.
export { default as Text } from '../Text'; // Re-exporting a default export
export { Button } from '../Button'; // Re-exporting a named export
// etc...The export names become the JSX tags people type. That is a limit with a direct consequence: a component you forgot to re-export does not exist in Playroom, and a rename here changes every saved design that used the old name. Treat this file as a public API for designers and review changes to it with the same care as changes to your library.
The scope option points at a file such as ./playroom/useScope.js for values beyond components, and the cwd option sets the working directory, shown in the example as ./playroom. The README gives no further detail on either in the section I could read, so read their source or docs before depending on them.
Optional settings that change the canvas: themes, widths, frame settings and example code
Most of the optional block shapes what the preview frames look like. title sets the name, with the example value My Awesome Library. themes points to a directory such as ./src/themes, which is what lets one design render in several themes at once. widths takes an array, with the example using 320, 768, and 1024, so those become the viewport sizes. frameComponent points to ./playroom/FrameComponent.js, a component that wraps each frame.
frameSettings takes objects with an id, a label, and a defaultValue; the example defines an rtl setting labelled RTL Layout that defaults to false. exampleCode is a template string with a Button whose content is Hello World, shown as starting code. webpackConfig is the escape hatch for builds that need custom bundling.
If you skip themes and widths you get a single design, so the headline feature of simultaneous themes and sizes is something you opt into by configuring it. Each extra theme and width means more frames rendering your components at once.
Port 9000 and openBrowser true are defaults, so two projects collide unless you set a port
A note under the config says port and openBrowser are set to 9000 and true when omitted. The repository's own scripts show why that matters in practice: the Cypress commands wait on ports 9000, 9001, and 9002, one for each fixture. Two Playroom servers on one machine cannot both take 9000, so set port explicitly in any project you run alongside another.
Two more options carry specifics. iframeSandbox sets the sandbox attribute on Playroom's iframe, and a minimum of allow-scripts is required for Playroom to work. Tightening the sandbox below that breaks the tool, so you can restrict what embedded code does only down to that floor.
defaultEditorPosition sets where the code editor sits on first load, matching the Editor Position menu, with 'left' or 'bottom' and bottom as the default. Once a user picks a position from the menu, their own preference is remembered and takes precedence, which means changing this option later will not move the editor for people who have already chosen.
Snippets give grouped, previewed insertions, and the URL carries the design
Snippets let people insert predefined code and see live previews across themes and viewports while moving through the list. They come from a snippets file that default-exports an array of objects with group, name, description, and code.
export default [
{
group: 'Components',
name: 'Button',
description: 'Strong weight',
code: `
<Button weight="strong">
Button
</Button>
`,
},
// etc...
];The group property is optional; when present, snippets appear grouped under that name in the UI. A snippet is only as good as the components it references, so keep the file in sync with your exports.
Sharing works by copying the URL. The demo links show how: the Braid link carries a code parameter after a hash, while the Polaris link carries it after a question mark. That matches the paramType option, whose default is 'hash' and which can be set to 'search'. Choose search if your host or router mishandles hash fragments.
Three releases in 2026, a pnpm monorepo with three fixtures, and an MIT license
Recent releases are v1.2.2 on 2026-03-30, v1.3.0 on 2026-07-01, and v1.4.0 on 2026-09-24, with the last push on 2026-10-30. The repository is not archived and the license is MIT. The default branch is master.
The root package.json is a private package named @playroom/monorepo and uses pnpm workspaces; the published package is the one under packages named playroom, built with `pnpm --filter playroom package`. Three fixture projects, basic, themed, and typescript, each have start, build, and serve scripts, and `pnpm test` runs vitest. Changesets drive versioning through `changeset version` and `changeset publish`, and linting covers eslint, knip, prettier, and tsc.
For a user the useful reading is that the project is organised around testing itself against a plain setup, a themed setup, and a TypeScript setup. Whichever of those your project resembles, the matching fixture shows a working configuration to copy.
Editorial conclusion
Playroom fits a team that already maintains a React-style component library and wants designers and engineers to mock up with real components, deployed next to the design system docs. It does nothing for a project without a component library to export, so check that first, then pick your own port and sandbox settings.
Frequently asked questions
How do I use Playroom from seek-oss?
Install it with npm install --save-dev playroom, add playroom:start and playroom:build scripts, create a playroom.config.js with components and outputPath, then run npm run playroom:start.
How do I set up Playroom for a component library?
Add a playroom.config.js to the project root, point components at a file that exports your components, and set outputPath for the built bundle. Optional settings include themes, widths, snippets and port.
Is seek-oss/playroom free to use?
The repository is licensed under MIT. Playroom is published as an npm package named playroom.
Official sources
Add this badge to your README
If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.
[](https://hysenlabs.com/projects/seek-oss-playroom)Star history chart for your README
[](https://hysenlabs.com/projects/seek-oss-playroom)Was this useful?