Skip to content
D
Documentation

Overview

reference
1 min readUpdated

@grafloria/element

Web component, dashboard kit and UML/ERD kits for Grafloria — diagrams and dashboards in any framework or none. Grafloria is an MIT diagram and dashboard engine for JavaScript.

Install

bash
npm install @grafloria/element @grafloria/engine @grafloria/renderer

It expects these alongside it:

  • @grafloria/engine ^0.3.16
  • @grafloria/renderer ^0.4.15

What it exports

  • Core: 20 exports, including defineGrafloriaFlow, DiagramSpec, fromDocument, FromDocumentOptions
  • Dashboard Kit: 65 exports, including BarWidgetData, bindDashboardGrid, boardHeightFor, buildCommitCommands
  • Diagram Kit: 53 exports, including addColumnAt, assignTiers, bindCardEditing, bindJoinGuidance
  • Stencil Kit: 9 exports, including bindShapeDataPanel, bindStencilPalette, ensureStencilKitStyles, ShapeDataPanelApi

Also exported from here

These names are documented with the package that defines them, and can be imported from this one too.

  • From @grafloria/renderer: activeRegistryScope, actorColor, actorInitials, AddWaypointResult, Adjacency, AlignmentGuide, ALWAYS_SAFE_MODE, analyseTopology, AnchorContext, AnchorFn, AnchorResult, ANCHORS and 967 more
  • From @grafloria/engine: Activity, ActorFrontier, ActorId, AddGroupCommand, AddLinkCommand, AddNodeCommand, AddOp, AddPortCommand, AddStrokeCommand, AddToGroupCommand, affectedRegion, AlignCommand and 914 more

Was this page helpful?

Overview — Grafloria