npmpackage.info

playroom

Design with JSX, powered by your own component library.

0.39.1

4,495

MIT

TypeScript

1.66 kB

8,569,646 4.8

Installations

npm install playroom

Score

60.8

Supply Chain

69.3

Quality

90.1

Maintenance

100

Vulnerability

92.6

License

Pull Requests

Open

10

Total

241

Closed

29

Merged

202

Issues

Open

31

Total

136

Closed

105

Releases

104

v0.39.1

Published on 06 Nov 2024

v0.39.0

Published on 10 Oct 2024

v0.38.1

Published on 02 Sept 2024

v0.38.0

Published on 11 Jun 2024

v0.37.1

Published on 04 Apr 2024

v0.37.0

Published on 07 Mar 2024

View all 104 releases

Developer

seek-oss

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=18.12.0

Typescript Support

Yes

Node Version

18.19.1

NPM Version

10.2.4 Statistics

4,495 Stars

216 Commits

185 Forks

44 Watching

21 Branches

49 Contributors

Updated on 19 Nov 2024

Bundle Size

5.46 kB

Minified

1.66 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (90.03%)

JavaScript (9.95%)

Shell (0.02%)

Total Downloads

Cumulative downloads

Total Downloads

8,569,646

Last day

-13.4%

13,450

Compared to previous day

Last week

14.5%

70,595

Compared to previous week

Last month

73.7%

290,813

Compared to previous month

Last year

11%

2,456,150

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

react react-dom

Dev Dependencies

jest husky react serve surge eslint cypress react-dom @types/jest lint-staged concurrently @actions/core @octokit/rest @changesets/cli eslint-config-seek @types/react-helmet start-server-and-test @testing-library/cypress @types/react-transition-group

Versions

Simultaneously design across a variety of themes and screen sizes, powered by JSX and your own component library.

Playroom allows you to create a zero-install code-oriented design environment, built into a standalone bundle that can be deployed alongside your existing design system documentation.

Iterate on your designs in the final medium.
Create quick mock-ups and interactive prototypes with real code.
Exercise and evaluate the flexibility of your design system.
Share your work with others by simply copying the URL.

Demos

Braid Design System (Themed)

Bumbag

Overdrive

Cubes (Themed)

Mesh Design System (Themed)

Mística Design System (Themed)

Shopify Polaris

Agriculture Design System

Send us a PR if you'd like to be in this list!

Getting Started

1$ npm install --save-dev playroom

Add the following scripts to your package.json:

1{
2  "scripts": {
3    "playroom:start": "playroom start",
4    "playroom:build": "playroom build"
5  }
6}

Add a playroom.config.js file to the root of your project:

1module.exports = {
2  components: './src/components',
3  outputPath: './dist/playroom',
4
5  // Optional:
6  title: 'My Awesome Library',
7  themes: './src/themes',
8  snippets: './playroom/snippets.js',
9  frameComponent: './playroom/FrameComponent.js',
10  scope: './playroom/useScope.js',
11  widths: [320, 768, 1024],
12  port: 9000,
13  openBrowser: true,
14  paramType: 'search', // default is 'hash'
15  exampleCode: `
16    <Button>
17      Hello World!
18    </Button>
19  `,
20  baseUrl: '/playroom/',
21  webpackConfig: () => ({
22    // Custom webpack config goes here...
23  }),
24  iframeSandbox: 'allow-scripts',
25  defaultVisibleWidths: [
26    // subset of widths to display on first load
27  ],
28  defaultVisibleThemes: [
29    // subset of themes to display on first load
30  ],
31};

Note: port and openBrowser options will be set to 9000 and true (respectively) by default whenever they are omitted from the config above.

Your components file is expected to export a single object or a series of named exports. For example:

1export { default as Text } from '../Text'; // Re-exporting a default export
2export { Button } from '../Button'; // Re-exporting a named export
3// etc...

The iframeSandbox option can be used to set the sandbox attribute on Playroom's iframe. A minimum of allow-scripts is required for Playroom to work.

Now that your project is configured, you can start a local development server:

1$ npm run playroom:start

To build your assets for production:

1$ npm run playroom:build

Snippets

Playroom allows you to quickly insert predefined snippets of code, providing live previews across themes and viewports as you navigate the list. These snippets can be configured via a snippets file that looks like this:

1export default [
2  {
3    group: 'Button',
4    name: 'Strong',
5    code: `
6      <Button weight="strong">
7        Button
8      </Button>
9    `,
10  },
11  // etc...
12];

Custom Frame Component

If your components need to be nested within custom provider components, you can provide a custom React component file via the frameComponent option, which is a path to a file that exports a component. For example, if your component library has multiple themes:

1import React from 'react';
2import { ThemeProvider } from '../path/to/your/theming-system';
3
4export default function FrameComponent({ theme, children }) {
5  return <ThemeProvider theme={theme}>{children}</ThemeProvider>;
6}

Custom Scope

You can provide extra variables within the scope of your JSX via the scope option, which is a path to a file that exports a useScope Hook that returns a scope object. For example, if you wanted to expose a context-based theme variable to consumers of your Playroom:

1import { useTheme } from '../path/to/your/theming-system';
2
3export default function useScope() {
4  return {
5    theme: useTheme(),
6  };

Theme Support

If your component library has multiple themes, you can customise Playroom to render every theme simultaneously via the themes configuration option.

Similar to your components file, your themes file is expected to export a single object or a series of named exports. For example:

1export { themeA } from './themeA';
2export { themeB } from './themeB';
3// etc...

TypeScript Support

If a tsconfig.json file is present in your project, static prop types are parsed using react-docgen-typescript to provide better autocompletion in the Playroom editor.

By default, all .ts and .tsx files in the current working directory are included, excluding node_modules.

If you need to customise this behaviour, you can provide a typeScriptFiles option in playroom.config.js, which is an array of globs.

1module.exports = {
2  // ...
3  typeScriptFiles: ['src/components/**/*.{ts,tsx}', '!**/node_modules'],
4};

If you need to customise the parser options, you can provide a reactDocgenTypescriptConfig option in playroom.config.js.

For example:

1module.exports = {
2  // ...
3  reactDocgenTypescriptConfig: {
4    propFilter: (prop, component) => {
5      // ...
6    },
7  },
8};

ESM Support

Playroom supports loading ESM configuration files. By default, Playroom will look for a playroom config file with either a .js, .mjs or .cjs file extension.

Storybook Integration

If you are interested in integrating Playroom into Storybook, check out storybook-addon-playroom.

Browser Support

Playroom is built to work on the latest stable versions of all major browsers. Some features may not work as expected in older browsers.

License

MIT.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-site.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/preview-site.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/preview-site.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/preview-site.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-site.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/preview-site.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snapshot.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/snapshot.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/snapshot.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/snapshot.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/snapshot.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/snapshot.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/snapshot.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/snapshot.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/validate.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/validate.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/validate.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/validate.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/validate.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/validate.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/seek-oss/playroom/validate.yml/master?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 6 third-party GitHubAction dependencies pinned

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.8

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More