govil-section-icon-boxes
v0.0.35
Published
A section of icon boxes
Downloads
6
Readme
section-icon-boxes
A simple React component that displays boxes of links with icons inside
How to use
Clone this repo to your local computer, then run:
npm install && npm run build
To make this component available to other projects on your local computer, run
yarn link
.Then go to the project where you want to use this package and run
yarn link "section-icon-boxes"
.
Finally, to fix the multiple copies of React bug that shows up with linked React packages:
- navigate to the root of the
section-icon-boxes
package - run
npm link "../path/to/your/project"
You can now import section-icon-boxes
as a normal package installed from npm like so:
import SectionIconBoxes from 'section-icon-boxes'
...
You can also import the type definitions if you're using TypeScript like so:
import * from 'section-icon-boxes'
...
Available props
className: string (optional)
To customise this component, pass in a class name to the className
prop and style that class name in your custom CSS.
// your-component.js
import SectionIconBoxes from 'section-icon-boxes'
...
<SectionIconBoxes className="dummy" />
...
This component was built for an article on how to publish a React component as a package to npm.