Skip to content

Commit

Permalink
Additional docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SchrodingersGat committed Oct 29, 2024
1 parent bb5555f commit b6a0140
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/docs/extend/plugins/ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ The InvenTree dashboard is a collection of "items" which are displayed on the ma
summary: False
members: []

#### Dashboard Item Options

The *options* field in the returned `UIFeature` object can contain the following properties:

::: plugin.base.ui.mixins.CustomDashboardItemOptions
Expand All @@ -91,6 +93,12 @@ The *options* field in the returned `UIFeature` object can contain the following
summary: False
members: []

#### Source Function

The frontend code expects a path to a javascript file containing a function named `renderDashboardItem` which will be called to render the custom dashboard item. Note that this function name can be overridden by appending the function name in the `source` field of the `UIFeature` object.

#### Example

Refer to the [sample plugin](#sample-plugin) for an example of how to implement server side rendering for custom panels.

### Panels
Expand All @@ -106,6 +114,8 @@ Many of the pages in the InvenTree web interface are built using a series of "pa
summary: False
members: []

#### Panel Options

The *options* field in the returned `UIFeature` object can contain the following properties:

::: plugin.base.ui.mixins.CustomPanelOptions
Expand All @@ -117,6 +127,12 @@ The *options* field in the returned `UIFeature` object can contain the following
summary: False
members: []

#### Source Function

The frontend code expects a path to a javascript file containing a function named `renderPanel` which will be called to render the custom panel. Note that this function name can be overridden by appending the function name in the `source` field of the `UIFeature` object.

#### Example

Refer to the [sample plugin](#sample-plugin) for an example of how to implement server side rendering for custom panels.

### Template Editors
Expand Down

0 comments on commit b6a0140

Please sign in to comment.