Skip to content

Commit

Permalink
Upadte the TS Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
csouchet committed Jun 20, 2023
1 parent 696d53d commit f42fc41
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions src/component/registry/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,15 @@ export type Stroke = StyleWithOpacity & {
/**
* Possible values are all HTML color names or HEX codes, as well as special keywords such as:
* - `default` to use the color defined in the BPMN element default style.
* - `none` for no color
* - `none` for no color.
* - `swimlane` to apply the stroke color of the nearest parent element with the type {@link ShapeBpmnElementKind.LANE} or {@link ShapeBpmnElementKind.POOL}.
* - `inherit` to apply the stroke color of the direct parent element.
*
* **Notes about the `default` special keyword**:
* - It can be used when the style is first updated and then needs to be reset to its initial value.
* - It doesn't use the color set in the BPMN source when the "BPMN in Color" support is enabled. It uses the color defined in the BPMN element default style.
*/
color?: 'default' | 'none' | string;
color?: 'default' | 'none' | 'swimlane' | 'inherit' | string;

/**
* Defines the stroke width in pixels.
Expand Down Expand Up @@ -211,12 +213,14 @@ export type Font = StyleWithOpacity & {
/**
* Possible values are all HTML color names or HEX codes, as well as special keywords such as:
* - `default` to use the color defined in the BPMN element default style.
* - `swimlane` to apply the font color of the nearest parent element with the type {@link ShapeBpmnElementKind.LANE} or {@link ShapeBpmnElementKind.POOL}.
* - `inherit` to apply the font color of the direct parent element.
*
* **Notes about the `default` special keyword**:
* - It can be used when the style is first updated and then needs to be reset to its initial value.
* - It doesn't use the color set in the BPMN source when the "BPMN in Color" support is enabled. It uses the color defined in the BPMN element default style.
*/
color?: 'default' | string;
color?: 'default' | 'swimlane' | 'inherit' | string;

/**
* The type of the value is int (in px).
Expand Down Expand Up @@ -253,13 +257,15 @@ export type Fill = StyleWithOpacity & {
/**
* Possible values are all HTML color names or HEX codes, as well as special keywords such as:
* - `default` to use the color defined in the BPMN element default style.
* - `none` for no color
* - `none` for no color.
* - `swimlane` to apply the fill color of the nearest parent element with the type {@link ShapeBpmnElementKind.LANE} or {@link ShapeBpmnElementKind.POOL}.
* - `inherit` to apply the fill color of the direct parent element.
*
* **Notes about the `default` special keyword**:
* - It can be used when the style is first updated and then needs to be reset to its initial value.
* - It doesn't use the color set in the BPMN source when the "BPMN in Color" support is enabled. It uses the color defined in the BPMN element default style.
*/
color?: 'default' | 'none' | string;
color?: 'default' | 'none' | 'swimlane' | 'inherit' | string;
};

/**
Expand Down

0 comments on commit f42fc41

Please sign in to comment.