Skip to content

Repository files navigation

GrapesJS Navbar

Simple navbar component for GrapesJS editor

GrapesJS


Summary

  • Plugin name: grapesjs-navbar
  • Blocks: navbar
  • Components:
    • navbar, navbar-container, navbar-nav-menu, navbar-nav-menu-link, navbar-burger-menu, navbar-burger-menu-line

Options

OptionDescriptionDefault
idThe ID used to create the block and component.navbar
labelThe label used for the block and the component.Navbar
blockObject to extend the default block, eg. { category: 'Extra', ... }. Pass a falsy value to avoid adding the block.{}
styleCustom CSS styles for the component. This will replace the default one.''
styleAdditionalAdditional CSS styles for the component. These will be appended to the default one.''
classPrefixComponent class prefix.navbar

Download

  • CDN
    • https://unpkg.com/grapesjs-navbar
  • NPM
    • npm i grapesjs-navbar
  • GIT
    • git clone https://github.com/GrapesJS/components-navbar.git.git

Usage

Directly in the browser

<linkhref="path/to/grapes.min.css" rel="stylesheet"/><scriptsrc="path/to/grapes.min.js"></script><scriptsrc="path/to/grapesjs-navbar.min.js"></script><divid="gjs"></div><scripttype="text/javascript">vareditor=grapesjs.init({container : '#gjs',plugins: ['grapesjs-navbar'],pluginsOpts: {'grapesjs-navbar': {/* ...options */}}});</script>

Modern javascript

importgrapesjsfrom'grapesjs';importpluginfrom'grapesjs-navbar';consteditor=grapesjs.init({container : '#gjs',// ...plugins: [plugin],pluginsOpts: {[plugin]: {/* options */}}// orplugins: [editor=>plugin(editor,{/* options */}),],});

Development

Clone the repository

$ git clone https://github.com/GrapesJS/components-navbar.git.git
$ cd grapesjs-navbar

Install it

$ npm i

Start the dev server

$ npm start

Build before the commit. This will also increase the patch level version of the package

$ npm run build

License

BSD 3-Clause

About

Simple navbar component for the GrapesJS editor

Resources

Stars

38 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages