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
FlaminWrap a1ee10c1c6 Button action for user prompt (#8676) 
* Commit for enhancement #7762

Added Question option for buttons which acts as a dialog prompting the user to confirm or cancel before continuing.

* Fixes

* Made changes to allow custom modal title

Changed Question to User Prompt
Allows custom title

* Revert "Made changes to allow custom modal title"

This reverts commit 42a43bef4914cd52b07a2b6964bf78aa50eb2707.

* Revert "Fixes"

This reverts commit 915a8718e5ac6dd32a6c3d377d5edb02fc8a3138.

* Adds custom title

Adds custom title

* Wrong version of buttonActions was commited

* Delete index.js

* refactor

* lint

Co-authored-by: Mel O'Hagan <mel@budibase.com>
 		2022-12-15 16:21:24 +00:00
..
src Button action for user prompt (#8676) 2022-12-15 16:21:24 +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
…
manifest.json Add compact setting to AttachmentField (#9052) 2022-12-15 13:59:03 +00:00
package.json v2.2.4-alpha.2 2022-12-15 14:13:23 +00: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 Merge branch 'master' into develop 2022-12-01 14:39: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