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
Adria Navarro 63afd34eb2 Bug - BUDI-6068 filters do not work for google sheets (#9886) 
* Add data-utils with filters

* Create data-utils

* Add data-utils to compiled code

* Reuse constants

* Fix tests

* Rename package to shared-core

* Namespace export shared-core

* Rely on rollup to bundle shared-core

* Revert "Rely on rollup to bundle shared-core"

This reverts commit e8b5a2bb9a.

* Updating version and removing private.

* Update version

* Increment versions.

* Implement sort

* Enabling sort

* v2.3.21-alpha.2

* Fix build

* Improve readability

* Move deepGet to shared helper

* Better type usage

* Fix types

* Configure types

* Fix vite refs

* Add dep

* Fixing depencencies on client

* Add missing dev command

* Fix loading issues

* Update versions to latest

* Multiple es6 and commonjs configs

* Config

* Use local packages on rollup for client

* Change shared-core and types entry points

---------

Co-authored-by: mike12345567 <me@michaeldrury.co.uk>
 		2023-03-09 12:25:12 +00:00
..
src Dynamic filter: Enrich columns (#9877) 2023-03-07 10:32:52 +00:00
.gitignore
…
.npmignore
…
LICENSE
…
README.md
…
manifest.json Feedback updates. Backed out parsing and simply renamed the field config property 2023-02-03 10:22:36 +00:00
package.json Bug - BUDI-6068 filters do not work for google sheets (#9886) 2023-03-09 12:25:12 +00:00
rollup.config.js Bug - BUDI-6068 filters do not work for google sheets (#9886) 2023-03-09 12:25:12 +00:00
yarn.lock Enable rollup to bundle PNG images due to new assets in frontend-core 2023-01-31 15:54:06 +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