
Product
Introducing Module Reachability: Focus on the Vulnerabilities That Matter
Module Reachability filters out unreachable CVEs so you can focus on vulnerabilities that actually matter to your application.
@primer/component-metadata
Advanced tools
[](https://www.npmjs.com/package/@primer/component-metadata) [](https://github.com/primer/comp
🚧 Work in progress. Expect frequent breaking changes.
A place to store component metadata shared across all implementations of Primer.
Install with npm or yarn:
npm install @primer/component-metadata
yarn add @primer/component-metadata
import metadata from "@primer/component-metadata";
metadata.components.progress_bar;
// {
// id: 'progress_bar',
// displayName: 'Progress bar',
// description: 'Use progress bars to visualize task completion.',
// implementations: {
// react: 'https://primer.style/components/ProgressBar',
// viewComponent: 'https://primer.style/view-components/components/progressbar',
// css: 'https://primer.style/css/components/progress'
// }
// }
Each component should have the following metadata:
Name | Description | Guidelines |
---|---|---|
id (required) | A unqiue string used to identify the component | The id of the component should be the component name in snake case (e.g. "progress_bar" ) |
displayName (required) | The name of the component | Use sentence case (e.g. "Progress bar" ) |
description (required) | Describe how the component should be used | Use active voice (e.g. "Use progress bars to ..." not "Progress bars are used to ..." ) |
guidelines | URL to design guidelines for the component | |
implementations.react | URL to React implementation of the component | |
implementations.viewComponent | URL to ViewComponent implementation of the component | |
implementations.css | URL to CSS impelementation of the component | |
implementations.figma | URL to Figma implementation of the component |
FAQs
[](https://www.npmjs.com/package/@primer/component-metadata) [](https://github.com/primer/comp
The npm package @primer/component-metadata receives a total of 257 weekly downloads. As such, @primer/component-metadata popularity was classified as not popular.
We found that @primer/component-metadata demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Module Reachability filters out unreachable CVEs so you can focus on vulnerabilities that actually matter to your application.
Company News
Socket is bringing best-in-class reachability analysis into the platform — cutting false positives, accelerating triage, and cementing our place as the leader in software supply chain security.
Product
Socket is introducing a new way to organize repositories and apply repository-specific security policies.