Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.48 KB

README.md

File metadata and controls

55 lines (36 loc) · 2.48 KB
Raw

npm

GrapesJS Google Material Icons Plugin

Demo

GJS Market

This is a plugin for GrapesJS, a free and open-source web builder that allows you to create web pages using a simple drag-and-drop interface. The GrapesJS Google Icons Plugin lets you easily select and replace icons in your web pages with Google icons.

Getting Started

To use this plugin, you'll need to have GrapesJS installed in your project. Once you have GrapesJS set up, you can install the GrapesJS Google Material Icons Plugin by running the following command:

    npm install grapesjs-google-material-icons
    
    Or

    yarn add grapesjs-google-material-icons

After installing the plugin, you can add it to your GrapesJS instance like this:

    grapesjs.init({
      ...
      plugins: ['gjs-google-material-icons'],
      pluginsOpts: {
        'gjs-google-material-icons': {}
      },
      ...
    });

How to Use

Once you have the plugin installed and added to your GrapesJS instance, you can start using it to select and replace icons in your web pages.

In the page you will be using generated page, don't forget to add one or more stylings for the google fonts:

      Outlined: "//fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,[email protected],100..700,0..1,-50..200&v=1704404084845",
      Rounded: "//fonts.googleapis.com/css2?family=Material+Symbols+Rounded:opsz,wght,FILL,[email protected],100..700,0..1,-50..200&v=1704404087635",
      Sharp: "//fonts.googleapis.com/css2?family=Material+Symbols+Sharp:opsz,wght,FILL,[email protected],100..700,0..1,-50..200&v=1704404089108"

To select an icon, simply drag and drop a block onto the canvas, and then double click on icon. This will open a dialog box with a list of Google icons that you can choose from. Select the icon you want, and the plugin will replace the existing icon with the new one. Note that the plugin currently only works if you have added the Google Material Icons font to your project, but support for SVG icons is coming soon.

Contributing

If you find a bug or have a feature request, please create an issue on the GitHub repository for this plugin. Pull requests are also welcome!

License

This plugin is released under the MIT License.