Need more exports from the @bpmn-io/properties-panel package

Users
1

Hello!

I am extending Properties Panel of Modeller with my custom properties.

Some utility entries like Tooltip and Description are widely used internally in the @bpmn-io/properties-panel package for different types of entries, but it is required to create similar or just copy those files into my project, because they are not exposed to be imported.

It would be really nice, if @bpmn-io/properties-panel would export things…

2

I guess you build a fairly custom-made extension. Could you share some more details?

You can already attach tooltips using currently exported facilities.

3

Well, that is an example for the group, and I am making entries components.
For example, I have due date editor, which accounts for working days calendars I have in my system.
That is an entry with text field and a button, which opens up a dialog for configuring Due Date options.
I also have some other custom entry components.

As for Description - looks like it was a false alarm - we are using

import {DescriptionEntry as Description} from '@bpmn-io/properties-panel'

But when it comes to rendering a tooltip in an entry component, which is not based on any other entries, it need to have tooltip as part of its own markup.
Currently, I had to copy in project content of https://github.com/bpmn-io/properties-panel/blob/main/src/components/entries/Tooltip.js

That’s what markup of the component looks like:

      <div>
        <label
          htmlFor={labelId}
          className='bio-properties-panel-label'
        >
          <Tooltip
            value={tooltip}
            forId={labelId}
            element={element}
          >
            {label}
          </Tooltip>
        </label>

        <input
          type='hidden'
          className='bio-properties-panel-input'
          value={value}
        />

        ... skipped a bit ...

      </div>

      <Description
        forId={id}
        element={element}
        value={description}
      />
    </div>
1 Like
4

Happy to take a contribution to expose Tooltip, if Description is already exposed in a similar manner.

5

Hello,

I totally agree with you! Having access to the Tooltip and Description utilities directly from the @bpmn-io/properties-panel package would make life so much easier when extending the properties panel. It feels a bit redundant to duplicate these files in our projects just to reuse the functionality that’s already implemented in the package.

If these utilities were exposed as imports, it would streamline development and reduce code duplication. It would also promote consistency across different projects using the same package. Hopefully, the maintainers will consider this as an enhancement, as it would greatly improve the overall developer experience.

Thanks for bringing this up!