defineSfnDiagram

function defineSfnDiagram(params?): void;

Defined in: src/element/index.ts:57

Register SfnDiagramElement under a custom element tag name.

No-ops outside a DOM environment (typeof customElements === 'undefined'), so importing this module on the server never throws. Also no-ops (rather than throwing NotSupportedError) when name is already registered, or when SfnDiagramElement was already registered under a different name - the spec allows registering one class under only one tag name ever, so a second call here (e.g. from a duplicate sfn-diagram/element/auto import elsewhere in the dependency graph) is a no-op rather than a crash.

Parameters

params?

DefineSfnDiagramParams = {}

Registration parameters

Returns

void

Example

import { defineSfnDiagram } from 'sfn-diagram/element';
defineSfnDiagram({ name: 'my-diagram' });