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
Andrew Kingston 0cb3e5d98d Convert marker popups to tooltips on hover 2022-03-14 11:45:26 +00:00
..
.vscode
…
src Convert marker popups to tooltips on hover 2022-03-14 11:45:26 +00:00
.gitignore Remove lodash and sort dependencies out 2022-01-31 09:32:06 +00:00
.npmignore
…
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 Added the default location behaviour back in. Added in a Map Attribution field for users who alter their tile url. Some refactoring based on feedback 2022-03-10 12:48:49 +00:00
package.json Merge remote-tracking branch 'origin/develop' into feature/map-component 2022-03-11 11:41:41 +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 Map refactored and dependency updates 2022-03-11 11:17:15 +00: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