@pxblue/angular-components
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    PX Blue Angular Components

    npm

    This is a library of custom components for use in PX Blue applications. For the most part, these components are meant to simplify building your application by providing re-usable components that implement common use cases in PX Blue and eliminating the need to multiple teams to build their own components for these.

    Refer to the Component Library API documentation site for a list of available components or see the repository the documentation for each individual component.

    Installation

    To install the PX Blue angular components from NPM as a dependency for your project, you can run the following command in your project root:

    yarn add @pxblue/angular-components
    

    NOTE: This install command will install the package from NPM. If you are a PX Blue developer working with components locally, you will want to follow the manual linking instructions - see below.

    NOTE: This component library requires that your application have @pxblue/themes and @angular/material installed.

    Building the Library

    To work with this library, first clone down the repository:

    git clone https://github.com/pxblue/angular-component-library
    cd angular-component-library
    

    The library can be built by running the following command. The resulting output will be in the /dist folder.

    yarn build
    

    There is also a demo project (/component-demo) in this repository that shows the components in use. You can automatically build the component library and link them to the node modules for the demo by running:

    yarn link:components
    

    Compatibility

    The following table outlines which versions of Angular and PX Blue resources will work together.

    @pxblue/angular-components @pxblue/angular-themes @angular + @angular/material
    ^2.0.0 ^5.0.0 ^8.0.0
    ^3.0.0 ^5.1.0 8.x - 9.x
    ^4.0.0 ^5.2.0 ^10.x
    ^4.4.0 ^6.1.0 ^10.x

    Running the demo projects

    This repository comes with two demo projects found within the /demos folder. The first is a Storybook application that allows you to see the components in isolation and interact with their properties. The second is a Showcase project that shows a combination of components in the context of a realistic interface.

    You can build, link, and start the demo applications in a single step by calling either

    yarn start:showcase
    

    or

    yarn start:storybook
    

    from the root directory.

    Using the Components

    See the documentation for information on using these components.

    Browser Support

    PX Blue libraries will work with any modern browser. For details refer to our Browser Support documentation.

    Install

    npm i @pxblue/angular-components

    DownloadsWeekly Downloads

    131

    Version

    5.0.0

    License

    BSD-3-Clause

    Unpacked Size

    1.07 MB

    Total Files

    145

    Last publish

    Collaborators

    • avatar