Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evoluteur/react-crud-icons
67 SVG icons for CRUD applications, packaged as a React component with light & dark themes and tooltip.
https://github.com/evoluteur/react-crud-icons
button-animation crud crud-app crud-application icon icon-pack icon-set icons iconset inline-svg material-design material-ui react react-component react-components svg svg-icons svg-sprites ui ui-components
Last synced: 7 days ago
JSON representation
67 SVG icons for CRUD applications, packaged as a React component with light & dark themes and tooltip.
- Host: GitHub
- URL: https://github.com/evoluteur/react-crud-icons
- Owner: evoluteur
- License: mit
- Created: 2019-09-01T03:26:43.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T05:20:58.000Z (5 months ago)
- Last Synced: 2024-12-15T06:46:53.110Z (10 days ago)
- Topics: button-animation, crud, crud-app, crud-application, icon, icon-pack, icon-set, icons, iconset, inline-svg, material-design, material-ui, react, react-component, react-components, svg, svg-icons, svg-sprites, ui, ui-components
- Language: JavaScript
- Homepage: https://evoluteur.github.io/react-crud-icons/
- Size: 642 KB
- Stars: 40
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# React-CRUD-Icons · [![GitHub license](https://img.shields.io/github/license/evoluteur/react-crud-icons)](https://github.com/evoluteur/react-crud-icons/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/react-crud-icons)](https://www.npmjs.com/package/react-crud-icons)
**React-CRUD-Icons** is a set of SVG icons for CRUD (Create, Read, Update, Delete) apps, implemented as a React component with light & dark themes and tooltip.
Check out [React-CRUD-Icons live demo](https://evoluteur.github.io/react-crud-icons/).
### 67 SVG Icons
A set of icons for CRUD applications... hand-picked among thousands at [Material Design Icons](https://materialdesignicons.com/).
![Screenshot](screenshots/react-crud-icons.png)
### 2 Themes
Themes: light, dark.
![Screenshot](screenshots/hover.gif)
To disable the icon hover effect, set theme = "none". It will only render the SVG without CSS classes.
### 6 Sizes
Sizes: tiny, small, medium, large, big, huge.
![Screenshot](screenshots/sizes.gif)
For really large size icons, checkout the [T-Shirts](https://www.redbubble.com/people/evoluteur/shop?artistUserName=evoluteur&collections=4052365&iaCode=all-departments) ;-)
## Installation
The package can be installed via [npm](https://www.npmjs.com/package/react-crud-icons):
```
npm install react-crud-icons --save
```You’ll need to install React and PropTypes separately since those dependencies aren't included in the package.
To rebuild the project:
```
npm install
npm run build
```## Usage
Below is a simple example of how to use the component in a React view. You will also need to include the CSS file from this package (or provide your own). The example below shows how to include the CSS from this package if your build system supports requiring CSS files (Webpack is one that does).
```js
import React from "react";
import Icon from "react-crud-icons";import "react-crud-icons/dist/react-crud-icons.css";
const ExampleComponent = () => (
);
```Notes:
- Icons only take focus on tab when the "onClick" property is set and they are not disabled.
- The component uses inline SVG for faster display.## Properties
| Prop | Description |
|-----------|--------------------------|
| name | Possible values: "account", "add", "add2", "alert", "apps", "arrow-left", "arrow-right", "bars", "browse", "calendar", "cards", "check", "chevron-down", "chevron-up", "clone", "close", "collapse", "comment", "comments", "compare", "copy", "dashboard", "delete", "documentation", "dots", "dots-v", "down", "download", "drag", "edit", "error", "expand", "export", "favorite", "filter", "help", "hide", "history", "home", "home-circle", "image", "import", "info", "json", "link", "list", "list-bulleted", "lock", "lock-open", "map-marker", "moon", "paperclip", "pie", "print", "remove", "save", "search", "settings", "show", "sort", "stats", "sun", "treemap", "undo", "up", "upload", "wand". |
| size | Possible values: "tiny", "small", "medium", "large", "big", "huge". |
| theme | Possible values: "light", "dark". Use theme="none" to display raw SVG without the CSS classes and hover effect.|
| tooltip | Tooltip text shown on hover. |
| disabled | Disable click event (icon in grey). |
| onClick | Callback function triggered when icon is clicked. If empty, there will be no hover effect on the icon. |
| className | Additional CSS class name. |## T-Shirts
If you don't have a computer or if your screen is not big enough, I'm also providing [icons on T-Shirts](https://www.redbubble.com/people/evoluteur/shop?artistUserName=evoluteur&collections=4052365&iaCode=all-departments).
[![Screenshot](screenshots/lol.jpg)](https://www.redbubble.com/people/evoluteur/shop?artistUserName=evoluteur&collections=4052365&iaCode=all-departments)
## License
Copyright (c) 2024 [Olivier Giulieri](https://evoluteur.github.io/).
React-CRUD-Icons is Open Source wih [MIT license](http://github.com/evoluteur/react-crud-icons/blob/master/LICENSE).
To suggest a feature or report a bug: [https://github.com/evoluteur/react-crud-icons/issues](https://github.com/evoluteur/react-crud-icons/issues)
Notes: React-CRUD-Icons was originaly made for [Evolutility-UI-React](https://github.com/evoluteur/evolutility-ui-react).