Home > @uniformdev/mesh-sdk > MeshLocationCore
MeshLocationCore interface
Core shared generic for a mesh location context
Signature:
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| dialogContext? | DialogContext & { params: unknown; returnDialogValue: (value: unknown) => Promise<void>; } | <p>(Optional) Context of a location when it is rendering inside a dialog in the Uniform app. This is set when: - You pop out the app using sdk.openCurrentLocationDialog() so the location is rendered in a dialog for more screen space - The current location is a named dialog that was opened from the location using sdk.openLocationDialog()</p><p>This is undefined when the current location is not a dialog.</p> | |
| isReadOnly | boolean | If true, any editable fields on the current location should be disabled as the user does not have permission or otherwise cannot change them. | |
| metadata | TMetadata | Gets the current location metadata, context data which is provided from the Uniform app to assist in rendering the Mesh UI Each location has a specific type of metadata that it is provided, which is typed automatically when the location is known. | |
| setValue | SetLocationFunction<TSetValue> | Sets the current value of the location. All locations other than 'settings' update into a parent form state and should be updated live as changes occur in the Mesh app. The 'settings' location writes to the database each time its value is set, and it should be treated as a form with a submit button. | |
| type | TType | The current location type (where in the Uniform app the mesh app is rendering) | |
| value | TValue | The current value of the location. Some locations have fixed types (i.e. dataType), and others have user-selected types (i.e. paramType) |