090ae5df49
* v2.1.46 * Update pro version to 2.1.46 * v2.2.0 * Update pro version to 2.2.0 * Fix for budibase plugin skeleton, which utilises the old import style. * Fix side nav styles * v2.2.1 * Update pro version to 2.2.1 * using dist folder to allow importing constants for openAPI specs * v2.2.2 * Update pro version to 2.2.2 * Fix for user enrichment call (updating to @budibase/nano fork) (#9038) * Fix for #9029 - this should fix the issue users have been experiencing with user enrichment calls in apps, essentially it utilises a fork of the nano library we use to interact with CouchDB, which has been updated to use a POST request rather than a GET request as it supports a larger set of data being sent as query parameters. * Incrementing Nano version to attempt to fix yarn registry issues. * v2.2.3 * Update pro version to 2.2.3 * Fix SQL table `_id` filtering (#9030) * Re-add support for filtering on _id using external SQL tables and fix filter key prefixes not working with _id field * Remove like operator from internal tables and only allow basic operators on SQL table _id column * Update data section filtering to respect new rules * Update automation section filtering to respect new rules * Update dynamic filter component to respect new rules Co-authored-by: Martin McKeaveney <martin@budibase.com> Co-authored-by: Budibase Release Bot <> Co-authored-by: mike12345567 <me@michaeldrury.co.uk> Co-authored-by: Martin McKeaveney <martinmckeaveney@gmail.com> |
||
---|---|---|
.. | ||
src | ||
.gitignore | ||
.npmignore | ||
LICENSE | ||
README.md | ||
manifest.json | ||
package.json | ||
rollup.config.js | ||
yarn.lock |
README.md
Manifest
The manifest.json
file exports the definitions of all components available in this version
of the client library. The manifest is used by the builder to correctly display components and
their settings, and know how to correctly interact with them.
Component Definitions
The object key is the name of the component, as exported by index.js
.
- name - the name displayed in the builder
- description - not currently used
- icon - the icon displayed in the builder
- hasChildren - whether the component accepts children or not
- styleable - whether the component accepts design props or not
- dataProvider - whether the component provides a data context or not
- bindable - whether the components provides a bindable value or not
- settings - array of settings displayed in the builder
Settings Definitions
The type
field in each setting is used by the builder to know which component to use to display
the setting, so it's important that this field is correct. The valid options are:
- text - A text field
- select - A select dropdown. Accompany these with an
options
field to provide options - datasource - A datasource (e.g. a table or a view)
- boolean - A boolean field
- number - A numeric text field
- detailURL - A URL to a page which displays details about a row. Exclusively used for grids which link to row details.
The available fields in each setting definition are:
- type - the type of field which determines which component the builder will use to display the setting
- key - the key of this setting in the component
- label - the label displayed in the builder
- defaultValue - the default value of the setting
- placeholder - the placeholder for the setting