MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
budibase/packages/client
History
Budibase Staging Release Bot 9d45d5d06e v1.0.167-alpha.5 2022-05-19 22:05:21 +00:00
..
src Merge pull request #5787 from Upgreydd/convert_text_to_boolean_for_custom_schema_in_select 2022-05-17 14:45:18 +01:00
.gitignore Remove lodash and sort dependencies out 2022-01-31 09:32:06 +00:00
.npmignore prep for NPM publish 2020-02-26 22:18:14 +00:00
LICENSE License cleanup 2021-11-17 14:21:16 +00:00
README.md fix: update README.md 2021-11-03 02:42:44 -03:00
manifest.json Show autocomplete only for select 2022-05-16 11:14:13 +01:00
package.json v1.0.167-alpha.5 2022-05-19 22:05:21 +00:00
rollup.config.js Don't run visualiser in client library when not in production 2022-02-14 18:01:43 +00:00
yarn.lock merge with master 2022-04-26 10:21:45 +01:00

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