⚛️ ➕ Primer Addons

Additional components for Primer React.

This repository contains additional React.js components for the @primer/react toolkit. The components are compliant with the Primer theming framework and aims to respect the Primer design system.

A Storybook showcasing the components and their options is available on https://primer-addons.datalayer.tech.

This project has been shared in a discussion on the Primer React main repository.

Current Addons

• Backdrop
• Brand Header
• Brand Header Lines
• Brand Footer
• Content Loader
• Card
• Closable Flash
• Masonry Box
• Slider
• Toolbar

Reactor Plugins

Three plugins for hosts built on @datalayer/reactor, imported by path so a page without a reactor never pulls it in:

import { AppearancePlugin, PageLayoutPlugin, ThemePlugin } from '@datalayer/primer-addons/lib/reactor';

• ThemePlugin keeps Primer's portals in the application's color mode and toggles that mode by command (Mod+Alt+C).
• AppearancePlugin puts the appearance menu — color mode, theme, the theme's description and a preview of it, the control the Datalayer header wears — in a slot, header by default, and brings ThemePlugin along as a dependency.
• PageLayoutPlugin arranges a host's slots as a page: what plugins put in page lies on a centred sheet over a quiet canvas, page-band is docked above it at the sheet's width (or floats over it as a card), page-chips sit under the band, and page-panel is a side panel opened from a toggle in the header. The layout (PageLayout), its toggle and its signals (pageLayoutPanelOpen, openPagePanel()…) are exported too, for a host that wires the parts itself — the Loop of @datalayer/agent-runtimes does, with the notebook as the page and the conversation as the panel.

The gallery example is a Reactor app built on the three: npm run gallery.

Develop

Install the dependencies.

npm i

Start the storybook.

npm run storybook

Start the playground.

npm dev

About Primer Design

• Design system https://primer.style

About Primer Icons

• Icons https://primer.style/design/foundations/icons

About Primer React

• GitHub repository https://github.com/primer/react
• Documentation https://primer.style/react
• Storybook https://primer.style/react/storybook

About Primer Brand

• GitHub repository https://github.com/primer/brand
• Documentation https://primer.style/brand
• Storybook https://primer.style/brand/storybook

Releases

Primer Addons is released in Npm.js.