JSPM

  • Created
  • Published
  • Downloads 25200
  • Score
    100M100P100Q161858F
  • License MIT

A simple properties panel for bpmn-js

Package Exports

  • bpmn-js-properties-panel
  • bpmn-js-properties-panel/lib/PropertiesActivator
  • bpmn-js-properties-panel/lib/Utils
  • bpmn-js-properties-panel/lib/cmd
  • bpmn-js-properties-panel/lib/factory/EntryFactory
  • bpmn-js-properties-panel/lib/factory/EntryFieldDescription
  • bpmn-js-properties-panel/lib/helper/AsyncCapableHelper
  • bpmn-js-properties-panel/lib/helper/CmdHelper
  • bpmn-js-properties-panel/lib/helper/ElementHelper
  • bpmn-js-properties-panel/lib/helper/EventDefinitionHelper
  • bpmn-js-properties-panel/lib/helper/ExtensionElementsHelper
  • bpmn-js-properties-panel/lib/helper/ImplementationTypeHelper
  • bpmn-js-properties-panel/lib/provider/bpmn
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/DocumentationProps
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/EventProps
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/ExecutableProps
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/IdProps
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/LinkProps
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/NameProps
  • bpmn-js-properties-panel/lib/provider/bpmn/parts/ProcessProps
  • bpmn-js-properties-panel/lib/provider/camunda
  • bpmn-js-properties-panel/lib/provider/camunda/CamundaPropertiesProvider
  • bpmn-js-properties-panel/lib/provider/camunda/element-templates
  • bpmn-js-properties-panel/lib/provider/camunda/element-templates/CreateHelper
  • bpmn-js-properties-panel/lib/provider/camunda/element-templates/Helper
  • bpmn-js-properties-panel/lib/provider/camunda/element-templates/parts/ChooserProps
  • bpmn-js-properties-panel/lib/provider/camunda/element-templates/parts/CustomProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/AsynchronousContinuationProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/CallActivityProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/CandidateStarterProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ConditionalProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ConnectorDetailProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ConnectorInputOutputParameterProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ConnectorInputOutputProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ExternalTaskConfigurationProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/FieldInjectionProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/FormProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/HistoryTimeToLiveProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/InputOutputParameterProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/InputOutputProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/JobConfigurationProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ListenerDetailProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ListenerFieldInjectionProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ListenerProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/MultiInstanceLoopProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/PropertiesProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ScriptTaskProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/ServiceTaskDelegateProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/StartEventInitiator
  • bpmn-js-properties-panel/lib/provider/camunda/parts/UserTaskProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/VariableMappingProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/VersionTagProps
  • bpmn-js-properties-panel/lib/provider/camunda/parts/implementation/ResultVariable
  • bpmn-js-properties-panel/lib/provider/camunda/parts/implementation/Script
  • bpmn-js-properties-panel/styles/properties.less

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bpmn-js-properties-panel) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

bpmn-js-properties-panel

Build Status

This is properties panel extension for bpmn-js.

bpmn-js-properties-panel screenshot

Features

The properties panel allows users to edit invisible BPMN properties in a convenient way.

Some of the features are:

  • Edit element ids, multi-instance details and more
  • Edit execution related Camunda properties
  • Redo and undo (plugs into the bpmn-js editing cycle)

Usage

Provide two HTML elements, one for the properties panel and one for the BPMN diagram:

<div class="modeler">
  <div id="canvas"></div>
  <div id="properties"></div>
</div>

Bootstrap bpmn-js with the properties panel and a properties provider:

var BpmnJS = require('bpmn-js/lib/Modeler'),
    propertiesPanelModule = require('bpmn-js-properties-panel'),
    propertiesProviderModule = require('bpmn-js-properties-panel/lib/provider/bpmn');

var bpmnJS = new BpmnJS({
  additionalModules: [
    propertiesPanelModule,
    propertiesProviderModule
  ],
  container: '#canvas',
  propertiesPanel: {
    parent: '#properties'
  }
});

Dynamic Attach/Detach

You may attach or detach the properties panel dynamically to any element on the page, too:

var propertiesPanel = bpmnJS.get('propertiesPanel');

// detach the panel
propertiesPanel.detach();

// attach it to some other element
propertiesPanel.attachTo('#other-properties');

Use with Camunda properties

In order to be able to edit Camunda related properties, use the camunda properties provider. In addition, you need to define the camunda namespace via camunda-bpmn-moddle.

var BpmnJS = require('bpmn-js/lib/Modeler'),
    propertiesPanelModule = require('bpmn-js-properties-panel'),
    // use Camunda properties provider
    propertiesProviderModule = require('bpmn-js-properties-panel/lib/provider/camunda');

// a descriptor that defines Camunda related BPMN 2.0 XML extensions
var camundaModdleDescriptor = require('camunda-bpmn-moddle/resources/camunda');

var bpmnJS = new BpmnJS({
  additionalModules: [
    propertiesPanelModule,
    propertiesProviderModule
  ],
  container: '#canvas',
  propertiesPanel: {
    parent: '#properties'
  },
  // make camunda prefix known for import, editing and export
  moddleExtensions: {
    camunda: camundaModdleDescriptor
  }
});

...

Additional Resources

Development

Running the tests

npm install

# if required: npm install -g grunt-cli

export TEST_BROWSERS=Chrome
grunt test

License

MIT