Nine-Pin Masters

    @microsoft/iot-cardboard-js
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-beta.57 • Public • Published

    build Storybook npm (tag)

    Quick start 📦

    What is iot-cardboard-js?

    iot-cardboard-js or cardboard is an open source React component library for creating internet of things (IoT) web experiences.

    Storybook 📖

    This project is developed using Storybook - an open source tool for building UI components in isolation. Our hosted storybook showcases the current library of iot-cardboard-js components. Learn more about Storybook.

    Note: Stories which require authentication or API interaction can be found in the local development storybook.

    Using iot-cardboard-js components 🔥

    Installing

    Install our beta package from npm with:

    npm install @microsoft/iot-cardboard-js@beta

    Import components into your app:

    import {
        StandalonePropertyInspector,
        ADTAdapter,
        MsalAuthService,
        KeyValuePairCard,
        //...
    } from 'iot-cardboard-js';

    Examples

    Storybook stories are the best way to learn how to use our components. Files ending in *.stories.tsx showcase components set up with mock data. While files ending in *.stories.local.tsx showcase components which authenticate and communicate with APIs. Stories are a great way to learn about the different ways to consume each of our components.

    Check out the KeyValuePairCard stories for an example of this.

    You can also see the code required to use a component by opening either the live or local storybook, selecting the docs tab at the top of a story, and clicking show code at the bottom right of a story panel. This opens a view of the code used to render that story!

    Questions for maintainers 🙏

    If you have a question for one of the project maintainers, please post the question here. We'll get back to you as soon as possible!

    Issue templates

    Contributing 🚀

    Contributor License Agreement 📃

    This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

    When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

    Code of conduct 📏

    This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

    Trademarks ™️

    This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

    Keywords

    none

    Install

    npm i @microsoft/iot-cardboard-js@1.0.0-beta.57

    Version

    1.0.0-beta.57

    License

    ISC

    Unpacked Size

    48.2 MB

    Total Files

    197

    Last publish

    Collaborators

    • matdarmsft