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
mike12345567 d13985af3f Fix for #3758 - updating the datetime cell renderer and form component to be capable of display time only formats, as well as adding an option to only select the time component for a date time form field. 2022-02-08 16:15:08 +00:00
..
.vscode publish:dev script to help client development 2019-09-12 15:04:07 +01:00
src Fix for #3758 - updating the datetime cell renderer and form component to be capable of display time only formats, as well as adding an option to only select the time component for a date time form field. 2022-02-08 16:15:08 +00:00
.gitignore Adding client lock file 2020-12-01 10:50:08 +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 Fix for #3758 - updating the datetime cell renderer and form component to be capable of display time only formats, as well as adding an option to only select the time component for a date time form field. 2022-02-08 16:15:08 +00:00
package.json v1.0.50-alpha.2 2022-02-08 14:51:54 +00:00
rollup.config.js Remove unmaintained rollup plugins for node and replace with rollup-plugin-polyfill-node 2022-01-11 14:01:50 +00:00
yarn.lock Update reset theme button to use white for light theme 2022-01-13 10:26:05 +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