You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/developer_guide/component_specification/component.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,9 +5,9 @@ title: "Component"
5
5
The component definition is used to specify the properties of a component. Below is an explanation of each method that can be used in the component definition:
6
6
7
7
-`component(String name)` - Builds new `ModifiableComponentDefinition` with the specified name. The name defines the component key (backend ID).
8
-
-`actions(A... actionDefinitions)` - Specifies the actions that the component can perform.
8
+
-[`actions(A... actionDefinitions)`](./action) - Specifies the actions that the component can perform.
9
9
-`categories(ComponentCategory... category)` - Defines the category or categories that the component belongs to, used to group components together in the UI.
10
-
-`connection(ModifiableConnectionDefinition connectionDefinition)` - Sets the connection definition for the component.
10
+
-[`connection(ModifiableConnectionDefinition connectionDefinition)`](./connection) - Sets the connection definition for the component.
11
11
-`connectionRequired(boolean connectionRequired)` - Indicates whether the component requires a connection to be configured before it can be used.
12
12
-`customAction(boolean customAction)` - Indicates if the component is REST-based.
13
13
-`description(String description)` - Provides a short description of the component.
Bearer Token authentication involves sending a token with each request. This token is typically obtained from an authorization server and represents the user's identity.
OAuth2 Authorization Code is a robust authorization framework that allows third-party applications to obtain limited access to a web service. It involves redirecting the user to an authorization server to obtain an authorization code, which is then exchanged for an access token.
Copy file name to clipboardExpand all lines: docs/src/content/docs/developer_guide/component_specification/property.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,20 @@ title: "Property"
7
7
The `ModifiableArrayProperty` class is a customizable property type designed to handle array values within a component.
8
8
9
9
-`array(String name)` - Initializes a new `ModifiableArrayProperty` with the specified name.
10
-
-`defaultValue(...)` - Sets the default value for the property using various data types such as Boolean, Integer, Long, Float, Double, String, or Map.
11
-
-`exampleValue(...)` - Provides an example value for illustrative purposes using various data types.
12
-
-`items(...)` - Specifies the properties that define the items in the array.
10
+
-`defaultValue(T... defaultValue)` - Sets the default value for the property using various data types such as Boolean, Integer, Long, Float, Double, String, or Map.
11
+
-`exampleValue(T... exampleValue)` - Provides an example value for illustrative purposes using various data types.
12
+
-`items(P.. properties)` - Specifies the properties that define the items in the array.
13
13
-`optionsLookupDependsOn(String... optionsLookupDependsOn)` - Defines dependencies for option lookups.
14
14
-`maxItems(long maxItems)` - Sets the maximum number of items allowed in the array.
15
15
-`minItems(long minItems)` - Sets the minimum number of items required in the array.
16
16
-`multipleValues(boolean multipleValues)` - Indicates whether the array can contain multiple values.
17
-
-`options(...)` - Specifies a list of options for the property or defines a function to dynamically generate options.
17
+
-`options(Option<Object>... options)` - Specifies a list of options for the property.
18
+
-`options(OptionsFunction optionsFunction)` - Defines a function to dynamically generate options.
18
19
19
20
### Boolean Property
20
21
22
+
The `ModifiableBooleanProperty` class is a customizable property type designed to handle boolean values within a component.
23
+
21
24
-`bool(String name)` - Initializes a new `ModifiableBooleanProperty` with the specified name.
22
25
-`defaultValue(boolean defaultValue)` - Sets the default value for the property.
23
26
-`exampleValue(boolean exampleValue)` - Provides an example value for illustrative purposes.
0 commit comments