https://github.com/fgnass/decap-cms-widget-iconify
Iconify Widget for Decap CMS
https://github.com/fgnass/decap-cms-widget-iconify
Last synced: 3 months ago
JSON representation
Iconify Widget for Decap CMS
- Host: GitHub
- URL: https://github.com/fgnass/decap-cms-widget-iconify
- Owner: fgnass
- Created: 2025-03-01T21:12:22.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-03-01T21:59:49.000Z (9 months ago)
- Last Synced: 2025-06-25T07:11:29.738Z (5 months ago)
- Language: TypeScript
- Size: 84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-decap-cms - decap-cms-widget-iconify - A custom widget for Decap CMS (formerly Netlify CMS) that allows you to search and select icons from Iconify collections. (Custom Widget)
README
# Iconify Widget for Decap CMS
A custom widget for [Decap CMS](https://decapcms.org/) (formerly Netlify CMS) that allows you to search and select icons from [Iconify](https://iconify.design/) collections.
## Features
- Search for icons from Iconify collections
- Preview selected icons
- Filter icons by collection or pattern
- Seamless integration with Decap CMS
## Installation
```bash
npm install decap-cms-widget-iconify
# or
yarn add decap-cms-widget-iconify
```
## Usage
```js
import CMS from 'decap-cms-app';
import { WidgetIconify } from 'decap-cms-widget-iconify';
// Register the widget
CMS.registerWidget(WidgetIconify.Widget());
```
### Configuration
You can configure the widget with the following options:
```js
CMS.registerWidget(
WidgetIconify.Widget({
// The Iconify collection to use (default: 'mdi')
collection: "material-symbols-light",
// Optional regex filter to limit icons
filter: /-outline-rounded$/,
})
);
```
### Field Configuration
Use the widget in your Decap CMS configuration:
```yaml
# In your config.yml
fields:
- label: 'Icon'
name: 'icon'
widget: 'icon'
```
## License
MIT