@ffras4vnpm/deleniti-praesentium-magnam

v1.0.0

Published

7 months ago

> Extending the properties panel changed significantly with `bpmn-js-properties-panel>=1`. For the `0.x` version of the library, check out [the 0.x branch](https://github.com/ffras4vnpm/deleniti-praesentium-magnam/tree/0.x). Read more on the changes [in t

Downloads

0High
0Medium
0Low

lank831011

nested css byteOffset a11y logger bound argv value status remove codes flags ES6 colors form-validation flatten lockfile ES2019 compiler utilities Array.prototype.findLast eventEmitter hash bind typanion bdd URL autoprefixer styled-components zod hasOwn tester weakset flag ESnext sharedarraybuffer property every superagent mixins xhr deep-clone Stream Array.prototype.includes jasmine jsdom jsonschema sanitize shell Object.assign getOwnPropertyDescriptor util buffers jsdiff east-asian-width io-ts reducer look-up reuse ponyfill iterate character set tap number ECMAScript 2016 debug harmony mime hooks Int16Array util.inspect callbound airbnb getPrototypeOf AsyncIterator ava uuid ansi styling class-validator ramda phone Array.prototype.flatMap look preprocessor Set take chai browserlist spinners WebSockets utility chromium Function.prototype.name match trimLeft environment variables width deep generics eslintplugin regular const testing awesomesauce bundling es6 descriptor keys cors up require native exec node mkdirs lru jwt jest pnpm9 proto rmdir l10n fetch less.js wordbreak signal [[Prototype]]color modules error-handling 3d array dataView Uint8ClampedArray ECMAScript 2015 is test javascript args string json-schema object regular expression ES2016 watchFile ES2015 web fast Array Array.prototype.flat chrome assign jQuery ascii react types mime-db collection.es6 fixed-width install xterm values call-bind buffer exit-code findLastIndex loading ECMAScript 2021 rate auth warning request make dir directory last ArrayBuffer.prototype.slice Object.entries polyfill exit interrupts serialize form column typedarrays gradients css delete prop guid regular expressions Object.values toSorted es-shim API copy RFC-6455 react-hooks Map querystring parents uninstall random slot logging ES2022 bluebird shim full Object.is Array.prototype.filter weakmap fast-deep-clone clone callback efficient busy metadata TypedArray input speed duplex transpile Float32Array formatting crypto String.prototype.trim tdd commander protocol-buffers variables in css es-abstract queueMicrotask indicator eslint-plugin file system ECMAScript 2018 less compiler libphonenumber npm link debugger CSS postcss vest idle serialization stream react pose redux stringify findLast configurable sequence art drop file URLSearchParams writable eslintconfig gradients css3 obj byte config validation setImmediate command-line spec optimizer validator merge redux-toolkit throat view ES2018 animation forEach 6to5 push authentication Object.fromEntries browserslist safe es2016 circular helpers electron names es2018 import lesscss connect prototype performance sorted 256 persistent map pure visual sameValueZero offset syntax progress packages eventDispatcher code points stylesheet fs groupBy byteLength key BigUint64Array monorepo Observable Array.prototype.contains ts react-testing-library touch css variable Array.prototype.findLastIndex matchAll prefix argument quote postcss-plugin password log enumerable figlet promises operating-system ECMAScript 2023 performant crypt emoji Underscore dependencies read es parser compile less YAML dependency manager WeakSet concurrency make consume TypeScript encryption slice toolkit react-hook-form classname sigint check bcrypt rm -fr Uint16Array ecmascript filter properties rm equality pipe rgb bootstrap less wordwrap japanese ES7 fp fantasy-land regex wrap Float64Array gestures structuredClone includes module transpiler tools typescript es8 Uint32Array ECMAScript 7 description settings inspect WebSocket descriptors express deterministic korean matches waapi symlink collection stringifier arraybuffer setPrototypeOf dayjs parse Promise style arrays ECMAScript 5 expression spring ES2017 ES2021 time pose format cache https gdpr classes WeakMap folder curried walk ReactiveExtensions throttle Push @@toStringTag censor mkdirp Int8Array ES2020 limited deep-copy Object.getPrototypeOf Object.defineProperty scheme-validation readable characters joi ES8 js sort sanitization tty which length flatMap ie framer qs immer Symbol minimal recursive tostringtag banner patch hookform dir point-free cjk es-shims traverse wait redact positive write unicode ES es2017 colour ES3 BigInt64Array Array.prototype.flatten glob user-streams higher-order css nesting stable create trimRight pyyaml fast-copy get styleguide middleware argparse babel-core extension internal slot text batch columns symlinks typed deepcopy equal group parent $.extend concat sham plugin three computed-types babel package queue omit tslib superstruct stdlib full-width watch validate Iterator toStringTag json-schema-validation ajv jsx functions karma setter handlers ES5 getintrinsic api dotenv real-time classnames browser shebang yup windows once private data limit ECMAScript 2022 rapid __proto__nodejs Observables Int32Array starter css less accessor rangeerror core-js Microsoft json ECMAScript 3 .env

Extending the properties panel changed significantly with bpmn-js-properties-panel>=1. For the 0.x version of the library, check out the 0.x branch. Read more on the changes in the changelog.

bpmn-js-properties-panel

A properties panel extension for bpmn-js that adds the ability to edit technical properties (generic and Camunda).

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 7 and Camunda 8 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:

import BpmnModeler from 'bpmn-js/lib/Modeler';
import {
  BpmnPropertiesPanelModule,
  BpmnPropertiesProviderModule,
} from 'bpmn-js-properties-panel';

const modeler = new BpmnModeler({
  container: '#canvas',
  propertiesPanel: {
    parent: '#properties'
  },
  additionalModules: [
    BpmnPropertiesPanelModule,
    BpmnPropertiesProviderModule
  ]
});

Styling

For proper styling include the necessary stylesheets:

<link rel="stylesheet" href="https://unpkg.com/@bpmn-io/properties-panel/dist/assets/properties-panel.css">

Dynamic Attach/Detach

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

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

// detach the panel
propertiesPanel.detach();

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

Edit Camunda Properties

To edit Camunda properties, you have to use a moddle extension so bpmn-js is can read and write Camunda properties and use a provider so these properties are shown in the properties panel.

For example, to edit Camunda 8 properties, use the Camunda 8 moddle extension and the Camunda 8 provider. Additionally, you should use behaviors specific to Camunda 8 to ensure parts of the model that are specific to Camunda 8 are maintained correctly.

import BpmnModeler from 'bpmn-js/lib/Modeler';
import {
  BpmnPropertiesPanelModule,
  BpmnPropertiesProviderModule,
  ZeebePropertiesProviderModule // Camunda 8 provider
} from 'bpmn-js-properties-panel';

// Camunda 8 moddle extension
import zeebeModdle from 'zeebe-bpmn-moddle/resources/zeebe';

// Camunda 8 behaviors
import ZeebeBehaviorsModule from 'camunda-bpmn-js-behaviors/lib/camunda-cloud';

const modeler = new BpmnModeler({
  container: '#canvas',
  propertiesPanel: {
    parent: '#properties'
  },
  additionalModules: [
    BpmnPropertiesPanelModule,
    BpmnPropertiesProviderModule,
    ZeebePropertiesProviderModule,
    ZeebeBehaviorsModule
  ],
  moddleExtensions: {
    zeebe: zeebeModdle
  }
});

API

`BpmnPropertiesPanelRenderer#attachTo(container: HTMLElement) => void`

Attach the properties panel to a parent node.

const propertiesPanel = modeler.get('propertiesPanel');

propertiesPanel.attachTo('#other-properties');

`BpmnPropertiesPanelRenderer#detach() => void`

Detach the properties panel from its parent node.

const propertiesPanel = modeler.get('propertiesPanel');

propertiesPanel.detach();

`BpmnPropertiesPanelRenderer#registerProvider(priority: Number, provider: PropertiesProvider) => void`

class ExamplePropertiesProvider {
  constructor(propertiesPanel) {
    propertiesPanel.registerProvider(500, this);
  }

  getGroups(element) {
    return (groups) => {

      // add, modify or remove groups
      // ...

      return groups;
    };
  }
}

ExamplePropertiesProvider.$inject = [ 'propertiesPanel' ];

Additional Resources

Development

Prepare the project by installing all dependencies:

npm install

Then, depending on your use-case, you may run any of the following commands:

# build the library and run all tests
npm run all

# spin up a single local modeler instance
npm start

# run the full development setup
npm run dev

License

MIT

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme