Giter Site home page Giter Site logo

sophiiae / carbon-addons-iot-react Goto Github PK

View Code? Open in Web Editor NEW

This project forked from carbon-design-system/carbon-addons-iot-react

0.0 0.0 0.0 145.36 MB

A collection of React components shared between IBM Watson IoT products.

Home Page: https://carbon-addons-iot-react.com

License: Apache License 2.0

JavaScript 84.89% CSS 0.01% HTML 0.09% SCSS 8.30% Shell 0.05% Handlebars 0.06% TypeScript 6.59%

carbon-addons-iot-react's Introduction

Carbon add-ons for Watson IoT

Carbon add-ons for Watson IoT

Carbon add-ons for Watson IoT is an open-source react component library built by IBM Watson Internet Of Things. With the Carbon Design System and IBM Design Language as its foundation, the library consists of working code, resources, and a vibrant community of contributors.

@latest npm version release @next npm version release Build Status Coverage Report Carbon add-ons for Watson IoT is released under the Apache-2.0 license PRs welcome

Installation

@latest from master   -   view @latest storybook

# with npm
npm install carbon-addons-iot-react d3@">=5.0.0 <=5.14.2"

# with yarn
yarn add carbon-addons-iot-react d3@">=5.0.0 <=5.14.2"

@next pre-releases from next   -   view @next storybook

# with npm
npm install carbon-addons-iot-react@next d3@">=5.0.0 <=5.14.2"

# with yarn
yarn add carbon-addons-iot-react@next d3@">=5.0.0 <=5.14.2"

d3 is a peer dependency due to the usage of @carbon/charts in various components. The required version range is specified in package.json

Subscribe to all pre-releases on next

Pre-release versions are available on carbon-addons-iot-react@next. The default version range that is automatically added to your package.json on install/add will only follow pre-releases on the same major.minor.patch version. The version range can be modifed to follow all pre-releases:

"dependencies": {
-    "carbon-addons-iot-react": "^2.139.0-next.4"
+    "carbon-addons-iot-react": "next"
  }

🚀 Quick Start

To test drive everything here, use create-iot-react-app. It will create a new project that is preconfigured with everything you need to begin to build an application.

npx create-iot-react-app <app-name>

Styling

What's included

carbon-addons-iot-react/
├── css
│   ├── carbon-addons-iot-react.css
│   └── carbon-addons-iot-react.css.map
├── scss
│   └── components
│       └── modal
│           └── _modal.scss
│       └── ...
│   └── globals
│       └── scss
│           └── _vars.scss
│           └── ...
│   └── styles.scss (sass entrypoint)

Compiled CSS files are provided for ease of use getting started.

A sass entrypoint is available at scss/styles.scss for use in your project.

Using sass files (instead of the compiled .css) infers usage of a SCSS pre-processor. All Sass files use the *.scss file extension. For transpiling Sass code, use node-sass based Sass compilers, for example, WebPack sass-loader or gulp-sass. Make sure your build process uses autoprefixer to ensure vendor prefixes are automatically added to your output CSS.

Feedback and improvement requests regarding this configuration would be appreciated, please open an issue.

Dependencies

Usage of this package does not require you to install additional Carbon packages; carbon-components, carbon-components-react, or @carbon packages (@carbon/grid, @carbon-layout, etc) as peer dependencies. You may still need these packages if you use them directly in your project.

🤲 Contributing

Please check out our Contribution Guidelines for more info on how you can help out!

Testing

You can find our component test statement here

If you are using our project with Jest tests, due to it's dependency on d3, you may have to add some mock to your Jest setup script. See this issue for more details: jestjs/jest#5379

Here's an example setup script, update your jest config to point to a setup script: setupFiles: ['setupJest.js'],

setupJest.js contents:

class SVGPathElement extends HTMLElement {}

window.SVGPathElement = SVGPathElement;
Deploys by Netlify

carbon-addons-iot-react's People

Contributors

bjornalm avatar bryancboyd avatar bryancboyd-test avatar cal-smith avatar carbon-bot avatar cgirani avatar davidicus avatar dennynguyen avatar dependabot[bot] avatar donisius avatar enricoberti avatar filipecorrea avatar hectordavis avatar herleraja avatar jkeen avatar joelarmendariz avatar jonguenther avatar kevinsperrine avatar kodiakhq[bot] avatar marcjv avatar potato-w avatar rawa-resul avatar scottdickerson avatar soniadeveloper avatar sstone2423 avatar stuckless avatar sunilkotiyaibm avatar tay1orjones avatar tomklapiscak avatar zvonimirfras avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.