JSPM

@patternfly/react-core

6.2.0-prerelease.26
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 101380
  • Score
    100M100P100Q153502F
  • License MIT

This library provides a set of common React components for use with the PatternFly reference implementation.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@patternfly/react-core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    PatternFly React - Core

    lerna PatternFly npm badge

    This project provides the React core components for the PatternFly project.

    Community: PatternFly website | Slack | Medium | Mailing list

    Table of contents

    1. Setup
    2. Contribution guidelines
    3. License

    Setup

    Before you begin, check out this overview of PatternFly to get familiar with the basic elements of the design system. These instructions also assume that an existing React project is set up. For more information on how to do this, please see our main README.

    Install the @patternfly/react-core NPM package

    • Using npm, run the following command to install:

      npm install @patternfly/react-core --save

      OR

    • Using yarn, run the following command to install:

      yarn add @patternfly/react-core

    Project configuration

    Each PatternFly component already contains the CSS related to the component. In order to have consistent styles throughout the application, PatternFly Base CSS should be used in the project, or some components may diverge in appearance. This import statement should be placed before your main application component is imported.

    import '@patternfly/react-core/dist/styles/base.css';

    Example component usage

    import { Button } from '@patternfly/react-core';
    
    export default <Button variant="primary">Button</Button>;

    All component documentation is available on PatternFly.org.

    Advanced usage

    1. Applying Overpass font

    Contribution guidelines

    All React contributors must first be PatternFly community contributors. If you are already a PatternFly community contributor, check out the React contribution guidelines to make React contributions.

    License

    PatternFly React is licensed under the MIT License.