grapesjs-icon-set 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/Readme.md +19 -4
  2. package/package.json +1 -1
package/Readme.md CHANGED
@@ -32,9 +32,18 @@ Import the icon set into your GrapesJS configuration file:
32
32
  ```javascript
33
33
  import grapesjs from 'grapesjs';
34
34
  import { icons } from 'grapesjs-icon-set';
35
+ import 'grapesjs/dist/css/grapes.min.css';
36
+ import grapesjsIconSet from 'grapesjs-icon-set';
35
37
 
36
38
  const editor = grapesjs.init({
37
39
  container: '#gjs',
40
+ plugins: [grapesjsIconSet],
41
+ pluginsOpts: {
42
+ [grapesjsIconSet]: {
43
+ category: 'UI Icons',
44
+ addDefaultIcons: false, // Set to false if you want to add icons manually for performance
45
+ },
46
+ },
38
47
  // ... rest of your config
39
48
  });
40
49
 
@@ -77,10 +86,16 @@ am.add([
77
86
  ## 📁 Directory Structure
78
87
 
79
88
  Your installation includes the following organized paths:
80
-
81
- * `dist/`: Optimized production builds (`index.js`, `index.esm.js`).
82
- * `src/svg/`: Raw SVG source files categorized by name and style.
83
- * `icons.json`: A manifest file for programmatically looping through the set.
89
+ grapesjs-icon-set/
90
+ ├── dist/
91
+ │ ├── index.js # CommonJS build
92
+ │ └── index.esm.js # ES Module (Tree-shakeable)
93
+ ├── src/
94
+ │ └── svg/ # Raw .svg source files
95
+ │ ├── home/
96
+ │ │ ├── round.svg
97
+ │ │ └── sharp.svg
98
+ └── icons.json # Manifest for metadata & searching
84
99
 
85
100
  ---
86
101
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "grapesjs-icon-set",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "Custom SVG icon set plugin for GrapesJS",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.esm.js",