https://github.com/omerg/react-tech-radar
A React Component for Tech Radar inspired by ThoughtWorks' technology decision sharing project
https://github.com/omerg/react-tech-radar
babel7 d3 es6 hooks javascript react storybook svg tech-radar
Last synced: about 1 year ago
JSON representation
A React Component for Tech Radar inspired by ThoughtWorks' technology decision sharing project
- Host: GitHub
- URL: https://github.com/omerg/react-tech-radar
- Owner: omerg
- License: mit
- Created: 2019-07-06T19:07:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-20T10:20:55.000Z (almost 3 years ago)
- Last Synced: 2025-04-18T01:00:15.797Z (about 1 year ago)
- Topics: babel7, d3, es6, hooks, javascript, react, storybook, svg, tech-radar
- Language: JavaScript
- Homepage: https://react-tech-radar.netlify.com
- Size: 1.65 MB
- Stars: 38
- Watchers: 1
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Tech Radar
A react component that generates an interactive radar, inspired by [thoughtworks.com/radar](http://thoughtworks.com/radar).
[Demo (Storybook)](https://react-tech-radar.netlify.app/?path=/docs/radar--docs)
## Installation
Using [npm](https://www.npmjs.com/):
npm install --save react-tech-radar
## Quick Start
```jsx
import React from 'react';
import Radar from 'react-tech-radar';
function App() {
const setup = {
rings: ['adopt', 'trial', 'assess', 'hold'],
quadrants: ['tools', 'techniques', 'platforms', 'languages'],
data: [
{
name: 'D3',
quadrant: 'tools',
ring: "assess"
},
{
name: 'TypeScript',
quadrant: 'languages',
ring: "trial"
},
{
name: 'Storybook',
quadrant: 'tools',
ring: "adopt"
}
]
};
return (
);
}
export default App;
```
## Props Setup
The following 3 props should be configured in order to setup the tech radar:
- quadrants
- rings
- data
### data
data prop is an array of JSON elements representing the description of technologies.
Elements in the array should be in the following form:
__Example:__
```json5
{
data: [
{
name: 'D3',
quadrant: 'tools',
ring: "assess"
},
{
name: 'TypeScript',
quadrant: 'languages',
ring: "trial"
},
{
name: 'Storybook',
quadrant: 'tools',
ring: "adopt"
}
]
}
```
### quadrants
quadrants prop is an array of strings which represent slices of the circular radar.
Any data element with the matching quadrant value goes into this slice
Elements in the array should be in the following form:
__Example:__
```json5
{
quadrants: ['tools', 'techniques', 'platforms', 'languages']
}
```
### rings
rings prop is an array of strings which represent at what level these technologies are adopted.
For each element in rings, every quadrant is divided into rings. Innermost ring is the first element of the rings array and
it usually represents the place for the most adopted technologies.
__Example:__
```json5
{
rings: ['adopt', 'trial', 'assess', 'hold'],
}
```
## Configuration Options
| Prop | Description | Default Value |
| :--- | :--- | ---: |
| width | The overall width of the main DOM element | 700px |
| fontSize | Font size of elements | 12px |
| itemFontSize | Set this if you want the items to have a different size than titles of quadrants and rings. If not set, defaults to fontSize | 12px |
| colorScaleIndex | A value from 0 to 5 for different collections of colors. See [Storybook Color Schemes](https://react-tech-radar.netlify.com/?path=/story/color-schemes--with-1) section for colors of each option. |5 |
| radiusDiminish | Radius of rings is not equal because of this constant. Each radius is x times greater than the outer one and x is this constant. | 1.5 |
#### Prop Types
```jsx
Radar.propTypes = {
quadrants: PropTypes.array.isRequired,
rings: PropTypes.array,
data: PropTypes.array,
width: PropTypes.number,
fontSize: PropTypes.number,
itemFontSize: PropTypes.number,
colorScaleIndex: PropTypes.number,
radiusDiminish: PropTypes.number
};
```
## Storybook
You can see various states of the radar (such as color schemes, results of configurations, etc.) on the [Storybook Page](https://react-tech-radar.netlify.com).
## Google SpreadSheets Integration
If you want a very quick data integration, you can check out the Google Spreadsheets example.
The source code for the example is in 'examples' folder and also there is a running example in [Storybook](https://react-tech-radar.netlify.com).
If you plug in [this data](https://docs.google.com/spreadsheets/d/1XkfUX8auztSkMoHwBEraDjHZgx7NEH59OyUZH-0IQGw/edit) you'll see [this visualization](https://react-tech-radar.netlify.com/?path=/story/basics--with-data-from-google-spreadsheet)
#### Sharing the sheet
- In Google sheets, go to 'File', choose 'Publish to the web...' and then click 'Publish'.
- Close the 'Publish to the web' dialog.
- Copy the URL of your editable sheet from the browser (Don't worry, this does not share the editable version).
The URL will be similar to https://docs.google.com/spreadsheets/d/1waDG0_W3-yNiAaUfxcZhTKvl7AUCgXwQw8mdPjCz86U/edit. In theory we are only interested in the part between '/d/' and '/edit' but you can use the whole URL if you want.
## License
[MIT](./LICENSE)