hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

more doc tweaks

Browse Source 
Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
This commit is contained in:
Jim Ehrismann 2020-12-07 10:13:20 -05:00
parent 1e2e72ce52
commit b1e4de219a
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/extensions/guides/stores.md
View File

@ -2,16 +2,17 @@
Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information.
A few of these are exposed by the extensions api for use by the extension developer. A few of these are exposed by the extensions api for use by the extension developer.
The `ClusterStore` manages cluster state data such as cluster details, and which cluster is active.
The `WorkspaceStore` similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. - The `ClusterStore` manages cluster state data such as cluster details, and which cluster is active.
The `ExtensionStore` is a store for managing custom extension state data. - The `WorkspaceStore` similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace.
- The `ExtensionStore` is a store for managing custom extension state data.
## ExtensionStore ## ExtensionStore
Extension developers can create their own store for managing state data by extending the `ExtensionStore` class. Extension developers can create their own store for managing state data by extending the `ExtensionStore` class.
This guide shows how to create a store for the [`appPreferences` guide example](../renderer-extension#apppreferences), which demonstrates how to add a custom preference to the Preferences page. This guide shows how to create a store for the [`appPreferences` guide example](../renderer-extension#apppreferences), which demonstrates how to add a custom preference to the Preferences page.
The preference is a simple boolean that indicates whether something is enabled or not. The preference is a simple boolean that indicates whether something is enabled or not.
The problem with this example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started.
The following example code creates a store for the `appPreferences` guide example: The following example code creates a store for the `appPreferences` guide example:
@ -66,7 +67,7 @@ The `toJSON()` method is complementary to `fromStore()`, and is called when the
`toJSON()` must provide a JSON serializable object, facilitating its storage in JSON format. `toJSON()` must provide a JSON serializable object, facilitating its storage in JSON format.
The `toJS()` function from [`mobx`](https://mobx.js.org/README.html) is convenient for this purpose, and is used here. The `toJS()` function from [`mobx`](https://mobx.js.org/README.html) is convenient for this purpose, and is used here.
Finally, the `examplePreferencesStore` is created by calling `ExamplePreferencesStore.getInstance<ExamplePreferencesStore>()`, and exported for use by other parts of the extension. Finally, `examplePreferencesStore` is created by calling `ExamplePreferencesStore.getInstance<ExamplePreferencesStore>()`, and exported for use by other parts of the extension.
Note that `examplePreferencesStore` is a singleton, calling this function again will not create a new store. Note that `examplePreferencesStore` is a singleton, calling this function again will not create a new store.
The following example code, modified from the [`appPreferences` guide example](../renderer-extension#apppreferences) demonstrates how to use the extension store. The following example code, modified from the [`appPreferences` guide example](../renderer-extension#apppreferences) demonstrates how to use the extension store.