Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ship-components/ship-components-icon
A react component for displaying icons from font files.
https://github.com/ship-components/ship-components-icon
babel css icons javascript javascript-library jsx loader react ship-components-icon webpack
Last synced: about 2 months ago
JSON representation
A react component for displaying icons from font files.
- Host: GitHub
- URL: https://github.com/ship-components/ship-components-icon
- Owner: ship-components
- License: mit
- Created: 2016-08-10T18:15:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T14:05:42.000Z (about 2 years ago)
- Last Synced: 2024-10-30T18:19:39.704Z (2 months ago)
- Topics: babel, css, icons, javascript, javascript-library, jsx, loader, react, ship-components-icon, webpack
- Language: CSS
- Homepage: https://www.npmjs.com/package/ship-components-icon
- Size: 1.13 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ship-components-icon
Material Design icons in css module format. Exports a css module that can be used with [webpack](http://webpack.github.io/).
[](https://www.npmjs.com/package/ship-components-icon)
[](https://david-dm.org/ship-components/ship-components-icon?type=dev)
## Usage
### ES6/JSX
The component is written using ES6/JSX therefore Babel is required to directly use it. The below example is based on using [webpack](http://webpack.github.io/) and [babel-loader](https://github.com/babel/babel-loader).
```js
import icon from "ship-components-icon";
class Example extends React.Component {
render() {
return (
);
}
}
```
### Webpack Configuration
This module is designed to be used with webpack but requires a few loaders.
```shell
npm install webpack babel-loader css-loader style-loader postcss-loader file-loader extract-text-webpack-plugin autoprefixer --save-dev
```
Below are is a sample of how to setup the loaders:
```js
/**
* Relevant Webpack Configuration
*/
{
[...]
module: {
loaders: [
// Setup support for ES6
{
test: /\.(jsx?|es6)$/,
exclude: /(node_modules|bower_components)/,
loader: 'babel'
},
// Setup support for CSS Modules
{
test: /\.css$/,
loader: ExtractTextPlugin.extract('style-loader', 'css-loader?modules&importLoaders=1&localIdentName=[name]__[local]___[hash:base64:5]!postcss-loader')
}
]
},
plugins: [
// Extract the css and put it in one file. Path is relative to output path
new ExtractTextPlugin('../css/[name]-modules.css', { allChunks: true })
],
[...]
}
```
## Finding icons
Icon names may not match what you find on the internet. To find the actual names of the icons you can follow the steps below to start a simple server that includes all of the icons in searchable form.
1. `npm install`
2. `npm start`
3. Open [http://localhost:8080](http://localhost:8080)
## Development
If you update icons.css (eg with new icons from the upstream source material-design-icons), do not add
".3d_rotation:before". This is not valid CSS because classes cannot start with a number.
Icons should be added or removed using [Icomoon](https://icomoon.io/app). In the `src/fonts/` folder there is a file called `selection.json` that can be uploaded to Icomoon, edited and then Icomoon can export all of the updated assets.
## History
- 1.2.1 - Fixes the missing comment_annotation after adding version icon
- 1.2.0 - Added subscription icon for versions
- 1.1.0 - Added comment_annotation icon
- 1.0.0 - Updated documention and moved out of development
- 0.1.2 - Removed invalid .3d_rotation:before from icons.css
- 0.1.1 - Fixes Grunt to build and run the server and cleans up readme file
- 0.1.0 - Initial
## License
The MIT License (MIT)
Copyright (c) SHIP
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.