@cavcon/react-gears
v0.0.5
Published
A React component for an animated gear
Downloads
1
Readme
react-gears
React-gears is a JavaScript library for creating a React component that displays an animated SVG gear.
Installation
npm install @cavcon/react-gears
Documentation
<Gear
numTeeth="12"
toothHeight="0.2"
outSideDegrees="13"
insideDegrees="15"
holeRadius="0.3"
/>
| Parameter | Default | Description | | -------------- | ------- | --------------------------------------------------------------------------------------------------- | | numTeeth | 12 | The number of teeth on the gear | | toothHeight | 0.2 | The height of the teeth | | outsideDegrees | 13 | The number of degrees of the circle for the tip of each teeth. Value of 0 will be a pointed tooth. | | insideDegrees | 15 | The number of degrees of the circle for the gap between each teeth. Value of 0 will display no gap. | | holeRadius | 0.3 | Radius of the internal hole. Value of 0 will hide the internal hole. |
License
Copyright (c) 2024 Cavanaugh Consulting LLC and individual contributors. Licensed under MIT license, see LICENSE for the full license.