This is a template repository as a basic starting point for developing custom blocks for Lowdefy. For a detailed description of how to build custom blocks, visit the Custom Blocks sections in the docs.
This repository contains basic example of blocks for the five different block categories; display, input, container, context and list. You can read more about how blocks are used in Lowdefy in the Blocks section of the docs.
A Lowdefy block has two files, the block meta data and the block React component.
- You must have node and yarn installed.
- Generate a repository from the template on Github or clone this repository.
- Run
yarn install, thenyarn start, then check the you block is served by viewing the meta data at: http://localhost:3002/meta/DisplayBlock.json. - Add the
typesto you the lowdefy.yaml. For example:
name: my-app
lowdefy: 3.10.1
types:
DisplayBlock:
url: http://localhost:3002/meta/DisplayBlock.json
# ...- Use your new block type in your Lowdefy app.
- Start your Lowdefy app and test if it works, run:
npx lowdefy@latest dev - Continue to develop your block React component. Change to your block will need auto reload the app in the browser, you need to hit refresh.
- Before deploying your blocks to a static file server, remember to change the
remoteEntryUrlfield in thewebpack.prod.jsfile to yout block URL. - Deploy your blocks and enjoy your ☕️.
- @lowdefy/blocks-basic: Official Lowdefy blocks some basic Html elements.
- @lowdefy/blocks-antd: Official Lowdefy blocks for Antd design.
- @lowdefy/blocks-color-selectors: Official Lowdefy blocks for react-color.
- @lowdefy/blocks-markdown: Official Lowdefy blocks to render Markdown.
- @lowdefy/blocks-amcharts: Lowdefy blocks to render AmCharts v4.
- @lowdefy/blocks-aggrid: Lowdefy blocks to render Ag-Grid tables.
- Getting started with Lowdefy - https://docs.lowdefy.com/tutorial-start
- Lowdefy docs - https://docs.lowdefy.com
- Lowdefy website - https://lowdefy.com
- Community forum - https://github.com/lowdefy/lowdefy/discussions
- Bug reports and feature requests - https://github.com/lowdefy/lowdefy/issues