https://github.com/carbon-design-system/carbon-addons-iot-react
A collection of React components shared between IBM Watson IoT products.
https://github.com/carbon-design-system/carbon-addons-iot-react
carbon-addons carbon-design-system ibm ibm-watson-iot iot
Last synced: about 2 months ago
JSON representation
A collection of React components shared between IBM Watson IoT products.
- Host: GitHub
- URL: https://github.com/carbon-design-system/carbon-addons-iot-react
- Owner: carbon-design-system
- License: apache-2.0
- Created: 2018-12-12T15:30:42.000Z (over 6 years ago)
- Default Branch: next
- Last Pushed: 2024-10-29T11:47:22.000Z (6 months ago)
- Last Synced: 2024-10-29T13:27:49.051Z (6 months ago)
- Topics: carbon-addons, carbon-design-system, ibm, ibm-watson-iot, iot
- Language: JavaScript
- Homepage: https://carbon-design-system.github.io/carbon-addons-iot-react/
- Size: 188 MB
- Stars: 96
- Watchers: 22
- Forks: 78
- Open Issues: 242
-
Metadata Files:
- Readme: .github/README.MD
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.MD
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.MD
Awesome Lists containing this project
README
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.
| Branch | Carbon version | Release |
| --------------------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`next`](https://github.com/carbon-design-system/carbon-addons-iot-react/tree/next) | v11 | 
|
| [`2.x.x`](https://github.com/carbon-design-system/carbon-addons-iot-react/tree/2.x.x) | v10 | 
|
| [`master`](https://github.com/carbon-design-system/carbon-addons-iot-react/tree/master) | v10 | -- |
## Installation
```bash
# 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"
```
Note:
> _`d3` is a peer dependency due to the usage of `@carbon/charts` in various
> components. The required version range is specified in
> [package.json](https://github.com/carbon-design-system/carbon-addons-iot-react/search?l=JSON&q=peerDependencies+d3)_
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:
```diff
"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`](https://github.com/davidicus/create-iot-react-app). It
will create a new project that is preconfigured with everything you need to
begin to build an application.
```bash
npx create-iot-react-app
```
## Styling
What's included
```bash
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](https://github.com/carbon-design-system/carbon-addons-iot-react/issues/new?assignees=&labels=%3Ahammer%3A++Enhancement&template=feature-request-or-enhancement.md&title=%5BComponentName%5D+request_title).
## 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](https://github.com/carbon-design-system/carbon-addons-iot-react/blob/HEAD/.github/CONTRIBUTING.MD) for
more info on how you can help out!
## Testing
You can find our component test statement
[here](./src/components/COMPONENT_TEST)
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:
Here's an example setup script, update your jest config to point to a setup
script: setupFiles: ['setupJest.js'],
```js
setupJest.js contents:
class SVGPathElement extends HTMLElement {}
window.SVGPathElement = SVGPathElement;
```
