tsai
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Budibase is an open-source low-code platform for creating internal apps in minutes. Supports PostgreSQL, MySQL, MSSQL, MongoDB, Rest API, Docker, K8s 🚀
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4174 Commits
2 Branches
842 Tags
313 MiB
 
 
 
 
 
 
Tree: 8d8cdcd732
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '8d8cdcd732'
${ noResults }
budibase/packages/standard-components
Martin McKeaveney 8d8cdcd732
app export with space in name 		5 years ago
..
public Changing record -> row in this update, completing the update of renaming in the builder, this release needs further testing. 6 years ago
scripts Linting. 6 years ago
src remove search carried over from other branch 5 years ago
.gitignore Remove old test dir and add yarn lockfile 6 years ago
LICENSE Correct licenses 6 years ago
README.md WIP component management and definition refactor 5 years ago
manifest.json Fixed stacked list 5 years ago
package.json app export with space in name 5 years ago
rollup.config.js lint fix 6 years ago
yarn.lock Updating BBUI. 5 years ago

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