Skip to content

Commit

Permalink
docs: add documentation for hidin elements in platforms
Browse files Browse the repository at this point in the history
  • Loading branch information
@soleksy-splunk
soleksy-splunk committed Oct 13, 2024
1 parent 4ffdb90 commit 8bbaa84
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 28 deletions.
14 changes: 8 additions & 6 deletions docs/configurations/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ 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.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. |
| 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.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. |
| distinguishPlatforms | boolean | If true, you can hide some elements, by additional `hideForPlatform` property. Currently there is support for `cloud` or `enterprise` platform. |

### Tabs properties

Expand All @@ -28,6 +29,7 @@ proxy configuration, and logging level configuration.
| [restHandlerModule](../advanced/custom_rest_handler.md) | string | It specify name of the REST handler script that implements the custom actions to be performed on CRUD operations for the given input. (Use with restHandlerClass) |
| [restHandlerClass](../advanced/custom_rest_handler.md) | string | It specify name of the class present in the restHandlerModule, which implements methods like handleCreate, handleEdit, handleList, handleDelete and is child class of splunktaucclib.rest_handler.admin_external.AdminExternalHandler. (Use with restHandlerModule) |
| customTab | Object | This property allows you to enable the [custom tab](../custom_ui_extensions/custom_tab.md) feature. |
| hideForPlatform | string | Defines for which platform element should be hidden from UI perspective. Works only if `distinguishPlatforms` is set to true for page. Currently only two platforms are supported `cloud` or `enterprise`. |

### Tab components

Expand Down
17 changes: 9 additions & 8 deletions docs/entity/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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.md)<span class="required-asterisk">\*</span> | string | To specify the type of entity to be rendered in inputs or configuration form. | - |
Expand All @@ -26,10 +26,11 @@ title: Entity

This section describes common options that can be used within the `options` object in entity properties.

| Property | Type | Description | Default Value |
|---------------------|---------|----------------------------------------------------------------------------------------|---------------|
| display | boolean | It chooses whether or not to display the field. | true |
| disableonEdit | boolean | When the form is in edit mode, the field becomes unable to be edited. | false |
| enable | boolean | The enable property sets whether a field is enabled or not. | true |
| requiredWhenVisible | boolean | It makes the field required on the UI when it appears. It is used only for visibility. | false |
| placeholder | string | (`Renounced`) The grey text is shown when the input is empty. | - |
| Property | Type | Description | Default Value |
| ------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| display | boolean | It chooses whether or not to display the field. | true |
| disableonEdit | boolean | When the form is in edit mode, the field becomes unable to be edited. | false |
| enable | boolean | The enable property sets whether a field is enabled or not. | true |
| requiredWhenVisible | boolean | It makes the field required on the UI when it appears. It is used only for visibility. | false |
| hideForPlatform | string | Defines for which platform element should be hidden from UI perspective. Works only if `distinguishPlatforms` is set to true for page. Currently only two platforms are supported `cloud` or `enterprise`. | - |
| placeholder | string | (`Renounced`) The grey text is shown when the input is empty. | - |
Loading

0 comments on commit 8bbaa84

Please sign in to comment.