1
0
Fork 0
mirror of synced 2024-08-18 19:41:30 +12:00
budibase/packages/client
Andrew Kingston 2a2466fbda More fixes (#9387)
* Mark filters as nested settings to support persisting bindings post block ejection

* Add support for searching on linked fields in blocks

* Fix multi-select pickers closing on every click

* Target spectrum root element by default when rendering popovers, and allow customisation via context for client library

* Don't send up invalid HBS expressions when filtering on dates in blocks with empty date value

* Move profile above theme in user dropdown
2023-01-19 16:09:40 +00:00
..
src More fixes (#9387) 2023-01-19 16:09:40 +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
manifest.json More fixes (#9387) 2023-01-19 16:09:40 +00:00
package.json v2.2.12-alpha.28 2023-01-19 15:08:06 +00:00
README.md fix: update README.md 2021-11-03 02:42:44 -03:00
rollup.config.js UX/UI updates and rollup config changes to exclude common warnings 2022-10-06 09:54:43 +01:00
yarn.lock Replace ts-jest with swc/jest (#9289) 2023-01-11 09:37:37 +00:00

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