API reference

Framework Helpers

nav-schema exports small helpers for turning the same schema into serialized attributes, React props, Vue bindings, and Angular templates.

helpers

import {
  createHtmlSidebarAttribute,
  createReactSidebarProps,
  createVueSidebarBinding,
  createAngularSidebarTemplate,
  createHtmlMegaMenuAttribute,
  createReactMegaMenuProps,
  createVueMegaMenuBinding,
  createAngularMegaMenuTemplate
} from "nav-schema";

HTML helpers

createHtmlSidebarAttribute() and createHtmlMegaMenuAttribute() serialize schemas for template-driven integration.

Framework helpers

React and Vue helpers return binding-friendly objects. Angular helpers return a host template string that includes the prefixed marker and serialized schema.