Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: document placeholder attribute on templates properties #3881

Merged
merged 1 commit into from
Jun 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,36 @@ Together with the `pattern` constraint, you may define your custom error message
]
```

### Placeholder

The following property types support the `placeholder` attribute:

- `String`
- `Text`

The attribute is supported for the following binding types:

- `property`
- `camunda:property`
- `camunda:in`
- `camunda:in:businessKey`
- `camunda:out`
- `camunda:field`

The placeholder is displayed when a field is empty:

```json
...
"properties": [
{
"label": "Web service URL",
"type": "String",
"binding": { ... },
"placeholder": "https://example.com"
}
]
```

### Display all entries

Per default, the element template defines the visible entries of the properties panel. All other property controls are hidden. If you want to bring all the default entries back, it is possible to use the `entriesVisible` property.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,27 @@ Together with the `pattern` constraint, you can define your custom error message
]
```

### Placeholder

The following property types support the `placeholder` attribute:

- `String`
- `Text`

The placeholder is displayed when a field is empty:

```json
...
"properties": [
{
"label": "Web service URL",
"type": "String",
"binding": { ... },
"placeholder": "https://example.com"
}
]
```

### Icons

It is possible to define custom icons to update the visual appearance of elements after applying an element template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,36 @@ Together with the `pattern` constraint, you may define your custom error message
]
```

### Placeholder

The following property types support the `placeholder` attribute:

- `String`
- `Text`

The attribute is supported for the following binding types:

- `property`
- `camunda:property`
- `camunda:in`
- `camunda:in:businessKey`
- `camunda:out`
- `camunda:field`

The placeholder is displayed when a field is empty:

```json
...
"properties": [
{
"label": "Web service URL",
"type": "String",
"binding": { ... },
"placeholder": "https://example.com"
}
]
```

### Display all entries

Per default, the element template defines the visible entries of the properties panel. All other property controls are hidden. If you want to bring all the default entries back, it is possible to use the `entriesVisible` property.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,27 @@ Together with the `pattern` constraint, you can define your custom error message
]
```

### Placeholder

The following property types support the `placeholder` attribute:

- `String`
- `Text`

The placeholder is displayed when a field is empty:

```json
...
"properties": [
{
"label": "Web service URL",
"type": "String",
"binding": { ... },
"placeholder": "https://example.com"
}
]
```

### Icons

It is possible to define custom icons to update the visual appearance of elements after applying an element template.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -459,6 +459,36 @@ Together with the `pattern` constraint, you may define your custom error message
]
```

### Placeholder

The following property types support the `placeholder` attribute:

- `String`
- `Text`

The attribute is supported for the following binding types:

- `property`
- `camunda:property`
- `camunda:in`
- `camunda:in:businessKey`
- `camunda:out`
- `camunda:field`

The placeholder is displayed when a field is empty:

```json
...
"properties": [
{
"label": "Web service URL",
"type": "String",
"binding": { ... },
"placeholder": "https://example.com"
}
]
```

### Display all entries

Per default, the element template defines the visible entries of the properties panel. All other property controls are hidden. If you want to bring all the default entries back, it is possible to use the `entriesVisible` property.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -569,6 +569,27 @@ Together with the `pattern` constraint, you can define your custom error message
]
```

### Placeholder

The following property types support the `placeholder` attribute:

- `String`
- `Text`

The placeholder is displayed when a field is empty:

```json
...
"properties": [
{
"label": "Web service URL",
"type": "String",
"binding": { ... },
"placeholder": "https://example.com"
}
]
```

### Icons

It is possible to define custom icons to update the visual appearance of elements after applying an element template.
Expand Down
Loading