Skip to content

Commit

Permalink
docs: align documentation for subdescription inputs (#1092)
Browse files Browse the repository at this point in the history 
align docs for subdescription on inputs page, currently it says that it
is property of service but it is property of page

---------

Co-authored-by: Viktor Tsvetkov <[email protected]>
  • Loading branch information
@soleksy-splunk @vtsvetkov-splunk
soleksy-splunk and vtsvetkov-splunk authored Mar 5, 2024
1 parent 9fe017e commit 91df819
Show file tree
Hide file tree
Showing 7 changed files with 58 additions and 56 deletions.
34 changes: 17 additions & 17 deletions docs/configurations/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,29 @@ proxy configuration, and logging level configuration.
### Configuration Properties

| Property | Type | Description |
|-------------------------------------------------------------------| ------ | ------------------------------------------------------- |
|-------------------------------------------------------------------|--------|---------------------------------------------------------|
| title<span class="required-asterisk">\*</span> | string | - |
| description | string | To provide a brief summary of an configuration page. |
| [subDescription](../advanced/sub_description) | object | To provide broader description of an configuration page |
| [subDescription](../advanced/sub_description.md) | object | To provide broader description of an configuration page |
| [tabs](#tabs-properties)<span class="required-asterisk">\*</span> | array | To specify a list of tab. |

### Tabs properties

| Property | Type | Description |
|--------------------------------------------------------------| ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name<span class="required-asterisk">\*</span> | string | To define the particular tab name. |
| title<span class="required-asterisk">\*</span> | string | To show the title of the tab. |
| [entity](../entity)<span class="required-asterisk">\*</span> | array | A list of fields and their properties. |
| [table](../table) | object | To display accounts stanza in table |
| style | string | By specifying this property in the global config file, the forms can either be opened as a new page or in a dialog. <br>Supported values are "page" or "dialog". <br> Default value is **dialog**. |
| options | object | This property allows you to enable the [saveValidator](../advanced/save_validator) feature. |
| hook | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook) page to learn more. |
| [warning](../advanced/custom_warning.md) | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form |
| conf | string | TBD |
| restHandlerName | string | TBD |
| restHandlerModule | string | TBD |
| restHandlerClass | string | TBD |
| customTab | Object | This property allows you to enable the [custom tab](../custom_ui_extensions/custom_tab) feature. |
| Property | Type | Description |
|-----------------------------------------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name<span class="required-asterisk">\*</span> | string | To define the particular tab name. |
| title<span class="required-asterisk">\*</span> | string | To show the title of the tab. |
| [entity](../entity/index.md)<span class="required-asterisk">\*</span> | array | A list of fields and their properties. |
| [table](../table.md) | object | To display accounts stanza in table |
| style | string | By specifying this property in the global config file, the forms can either be opened as a new page or in a dialog. <br>Supported values are "page" or "dialog". <br> Default value is **dialog**. |
| options | object | This property allows you to enable the [saveValidator](../advanced/save_validator.md) feature. |
| hook | object | It is used to add custom behaviour to forms. Visit the [Custom Hook](../custom_ui_extensions/custom_hook.md) page to learn more. |
| [warning](../advanced/custom_warning.md) | object | It is used to add custom warning message for each of modes ('create', 'edit', 'config', 'clone'), message is displayed on form |
| conf | string | TBD |
| restHandlerName | string | TBD |
| restHandlerModule | string | TBD |
| restHandlerClass | string | TBD |
| customTab | Object | This property allows you to enable the [custom tab](../custom_ui_extensions/custom_tab.md) feature. |

### Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/entity/components.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ It supports files that can be opened in text mode or with a text editor, which a

It only sends file content to the server by reading it using the [readAsArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/API/FileReader/readAsArrayBuffer) method of the FileReader class, and then decoding it into **UTF-8** format, using the [decode](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder/decode) method of the TextDecoder class.

The file content can be validated using in-built validators such as [string](../validators/#string) and [regex](../validators/#regex), and a custom validator can also be implemented using a [custom hook](../../custom_ui_extensions/custom_hook) and [saveValidator](../advanced/save_validator).
The file content can be validated using in-built validators such as [string](validators.md#string) and [regex](validators.md#regex), and a custom validator can also be implemented using a [custom hook](../custom_ui_extensions/custom_hook.md) and [saveValidator](../advanced/save_validator.md).

This feature allows you to upload a single file.

Expand Down
26 changes: 13 additions & 13 deletions docs/entity/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ title: Entity

## Entity Properties

| Property | Type | Description | Default Value |
|---------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------|
| field<span class="required-asterisk">\*</span> | string | To define a particular entity field. | - |
| label<span class="required-asterisk">\*</span> | string | It represents a caption for a field in a user interface. | - |
| [type](./components)<span class="required-asterisk">\*</span> | string | To specify the type of entity to be rendered in inputs or configuration form. | - |
| help | string | Help text gives context about a fields input, such as how the input will be used. It is displayed directly below an input field. | - |
| tooltip | string | Displays a tooltip beside the label. | - |
| defaultValue | string, number or boolean | The initial input value. | - |
| [options](#common-options) | object | To specify an additional attribute for a particular type of entity, such as `items` for a radio bar. | - |
| required | boolean | To specify whether the field is required or not. | false |
| encrypted | boolean | To encrypt that particular field. | false |
| [validators](./validators) | array | It is used to validate the values of fields using various validators. | - |
| [modifyFieldsOnValue](./modifyFieldsOnValue) | array | It is used to speficy values and parameters that will influence visually other entities. | - |
| Property | Type | Description | Default Value |
|------------------------------------------------------------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------|
| field<span class="required-asterisk">\*</span> | string | To define a particular entity field. | - |
| label<span class="required-asterisk">\*</span> | string | It represents a caption for a field in a user interface. | - |
| [type](./components.md)<span class="required-asterisk">\*</span> | string | To specify the type of entity to be rendered in inputs or configuration form. | - |
| help | string | Help text gives context about a fields input, such as how the input will be used. It is displayed directly below an input field. | - |
| tooltip | string | Displays a tooltip beside the label. | - |
| defaultValue | string, number or boolean | The initial input value. | - |
| [options](#common-options) | object | To specify an additional attribute for a particular type of entity, such as `items` for a radio bar. | - |
| required | boolean | To specify whether the field is required or not. | false |
| encrypted | boolean | To encrypt that particular field. | false |
| [validators](./validators.md) | array | It is used to validate the values of fields using various validators. | - |
| [modifyFieldsOnValue](./modifyFieldsOnValue.md) | array | It is used to speficy values and parameters that will influence visually other entities. | - |

> [!WARNING]
> The [Placeholder](https://splunkui.splunk.com/Packages/react-ui/Text?section=develop) attribute is deprecated and will be removed in the next major version.
Expand Down
Loading

0 comments on commit 91df819

Please sign in to comment.