Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Learn about Components within Budibase
Components are the building blocks of Budibase. They are used to construct your user interface. At budibase we use the Spectrum design system created by Adobe. This gives you a great out-of-the-box experience where things just work. As a plus you also get themes by default.
There are a number of components in Budibase. They can be found along the top of the preview window in the Design section.
When you have added a component you will be able to see the options that you can tweak on the right side under the Settings bar. Some components also have a toolbar that will appear above it in the preview window.
Here's a list of links to the current components that are available:
Learn about the Container component within Budibase
A Container is a Div
with pre-defined styles. They are the building blocks of your application and critical for responsive design. Containers are used to structure your application and to contain other elements in a structured way. An analogy that may help your understanding is to think of Containers as picture frames hanging on a gallery wall (your application).
The Data Provider makes all your other components come alive with data
The data provider component is one of the most important components in Budibase. It exposes data to your children. Whenever you want to use data from your backend or from external sources you need this component.
In addition to controlling which data source that should be available to your children it also lets you sort and filter your data. For example, let's say that we have a list of invoices in a table. To only show relevant data to the user we simply filter it on the status isPaid
.
Once you have added your data provider you need to select which Data source you want to use. It's as simple as clicking the Data setting button.
Something that is worth thinking about when working with the Data Provider component is that the component structure is important. Only the children of your provider will have access to the data.
There are a number of different ways in which you can use the Data Provider; Charts, Tables and/or Repeaters.
If you choose to use a Chart or Table you can simply add them as a child and select the provider in the settings. However, if you want to build something a bit more custom, maybe you want a list of cards, then you will need the Repeater component. You can learn more about the Repeater here. Here's an example of a list of fictive invoices:
An easy way to split your content into multiple columns
The Section component can only be used as a top-level component. It's main use is to split up your content into multiple columns. This is a great component to use when building something like a dashboard.
The section takes an unlimited number of children; the first one will be placed in the first column and the second in the second column and so on. If you add more children than there are sections it will wrap-around and start from the first column again.
You can change number of columns by changing the Type setting. There are currently four different layouts: Main with Sidebar
, Sidebar with Main
, Two Columns
and Three columns
.
Learn about the Table component within Budibase
Learn about the Repeater component within Budibase
The repeater component is used to loop over your data. Every child of your repeater will thus be repeated for every row in the data provider that you have selected.
To get started with it, add it as a child to a data provider and in the settings, select the data provider. You can then add your components and get started. An example structure can be seen below:
Learn about the Text component within Budibase
Use the Text component to display Text. The Text component is versatile and can be styled using the Design panel. The Text component comes in two types: Heading and Paragraph. They both share the same settings. Both Text components can be bound to data in your Tables when used with the Repeater component.
To add Text to your designs:
To add Text from your tables to your designs:
Within the Design panel, you will find the Typography section. You can style your text using the available properties.
Learn about the Charts component within Budibase
Use the Chart component to display data from your tables to your users in a visually pleasing manner. The chart components pull in two types of values from your Tables; an X value and a Y value. The data within the column linked to the Y-axis must be a 'Number' (data type).
To add a new chart to your designs:
There are 4 types of charts within Budibase and they all have different settings and data requirements:
The Donut Chart (also known as Doughnut chart) is a variation on a Pie chart except it has a round hole in the center which makes it look like a donut, hence the name.
The Donut Chart component comes with the following settings:
Setting
Required
Description
Name
Yes
Change the name of the component
Table
Yes
Choose a table to link your chart to
Name Field
Yes
Select the column would you like to set as your categories
Value Field
Yes
Select the column you would like to display as your values (must be a number data type)
Animate chart
No
Tell your chart to load in an animated fashion
Hover highlight
No
Tell your chart to display the relevant value when the user hovers
Keep last hover
No
Tell your chart to continue to present the last value hovered
Colors
No
Select different color palettes
Legend width
No
Control the width of the accompanying legend
The classic Bar Chart uses either horizontal or vertical bars (column chart) to show discrete, numerical comparisons across categories. One axis of the chart shows the specific categories being compared and the other axis represents a value scale.
The Bar Chart component comes with the following settings:
Setting
Required
Description
Name
Yes
Change the name of the component
Table
Yes
Choose a table to link your chart to
Name Field
Yes
Select the column would you like to set as your categories
Value Field
Yes
Select the column you would like to display as your values (must be a number data type)
Y-Axis Label
No
Add a label to your Y-Axis
X-Axis Label
No
Add a label to your X-Axis
Colors
No
Select different color palettes for your bars
Gradients
No
Select different gradients palettes for your bars
Highlight single bar
No
Highlight a bar when hovered
Width
No
Give your chart a width
Height
No
Give your chart a height
A line chart (also known as a line plot or line graph) is a chart that uses lines to connect individual data points that display quantitative values over a specified time interval. The Line Chart component comes with the following settings:
Setting
Required
Description
Name
Yes
Change the name of the component
Table
Yes
Choose a table to link your chart to
Name Column
Yes
Select the column would you like to set as your categories
Value Column
Yes
Select the column you would like to display as your values (must be a number data type)
Date
Yes
Select the column you would like to display as your dates (must be a data/time data type)
Colors
No
Select different color palettes for your bars
Line Curve
No
Set how you would like the line curve displayed
X-Axis Value Type
No
Select between data and number
Grid
No
Dictate the direction of the grid
Y-Axis Label
No
Add a label to your Y-Axis
X-Axis Label
No
Add a label to your X-Axis
Show All Datapoints
No
Select to highlight data points on your chart
Width
No
Give your chart a width
Height
No
Give your chart a height
Is Animated
No
Tell your chart to load in an animated fashion
Locale
No
Select between a UK and US locale format
X-Axis Value Type
No
Select between a number and date format
X-Axis Format
No
Select your date format
Tooltip title
No
Provide a title for your tooltip
X Ticks
No
Outline how many integers you would like along your X-Axis
Y Ticks
No
Outline how many integers you would like along your Y-Axis
Setting
Required
Description
Name
Yes
Change the name of the component
Table
Yes
Choose a table to link your chart to
Group Column
Yes
Select the column you would like to use to group your bars
Name Column
Yes
Select the column would you like to set as your categories
Value Column
Yes
Select the column you would like to display as your values (must be a number data type)
Colors
No
Select different color palettes for your bars
Width
No
Give your chart a width
Height
No
Give your chart a height
Grid
No
Dictate the direction of the grid
Y Ticks
No
Outline how many integers you would like along your Y-Axis
Is Animated
No
Tell your chart to load in an animated fashion
Is Horizontal
No
Transform your vertical grouped bar chart to a horizontal grouped bar chart
Tooltip Title
No
Provide a title for the chart's tooltips (hover over bars to see)
Learn about the Image component within Budibase
The image component is used to display images.
To add an Image to your designs:
To add multiple Images from your Tables to your designs:
The Image component can accept multiple styling updates from the design panel, including Size, Effects, and margin.
Learn about the Button component within Budibase
Use the button component to encourage users to take actions, and make choices, with a single click or tap. The Button component requires text and an action.
To add a Button to your designs:
The Button component is versatile and can accept updates from all of the design properties. Once you have finished the initial design, you should enhance your button with a Hover and Active class →.
Within the setup panel, you can give your Button actions →.
Learn about the Icon component within Budibase
This component is using the fantastic Font Awesome icon font, a project by Dave Gandy. Altogether Font Awesome provides more than 1500 symbols and glyphs for web-related actions. These icons are great, because they enable you to easily change color, size, and more via the Design panel. They are scalable vector graphics, which means that they look great on high-resolution displays.
To add an Icon to your designs:
The Icon component can accept multiple styling updates from the design panel, including size, color, and margin.
Learn about the Embed component within Budibase
The Embed component is used to embed content into your web application. This content is provided by an external application or other sources of interactive content such as a browser plug-in. Types of content can range from SVGs, PDFs, Maps, to web pages.
is one kind of common iframe attack where hackers embed an invisible iframe into your document (or embed your document into their own malicious website) and use it to capture users' interactions. This is a common way to mislead users or steal sensitive data.
To add the Embed component to your designs:
Learn about the Link component within Budibase
Use the Link component to offer your users a way to navigate to other destinations. The Link component is built on top of the Text component. Just like the Text component, you can leverage the available styling properties with the Design panel.
To add a Link to your designs:
The Link button accepts the majority of properties within the Design panel. A common style update to the Link component is to remove the underline. To do this, click Design
, then open the Typography settings, reset the Decoration to None
. This may already be on None. If it is, reselect None and it should work.
Learn about the Cards component within Budibase
Use the Card component to display data from your tables to your users in a structured, repetitive manner. Cards contain content and in some cases images and actions about a single subject. There is currently two types of Card component; vertical and horizontal.
Important! If you select the component, select a table, and add the Card component to it, you can generate multiple cards at once.
To add a new Card to your designs:
There are 2 types of Cards within Budibase. Each Card has its own unique settings. The Card component can also accept some style updates from the Design panel i.e Background - Gradient: Heavy Rain
:
The Vertical Card is structured in a vertical manner - items are stacked on top of each other.
The Vertical Card component comes with the following settings:
The Horizontal Card is structured in a horizontal manner - items are stacked alongside each other.
The Horizontal Card component comes with the following settings:
Click the layout dropdown, and select the component
Link your component to the Table which contains the data you would like to display
In the Card's Setup panel, your data from your Tables to your Card component using the ✎ icon.
Setting
Description
Name
Change the name of the component
Image
Add an image to your Card
Heading
Add a heading to your card, directly under the image
Description
Add a description to your card, directly under the heading
Link Text
Add the text of your link to your card, directly under the description
Link URL
Activate your link with a URL
Link Color
Change the color of your link
Hover Color
Change the hover color of your link
Image Height
Set your image's height (in rem)
Card Width
Set the width of your Card
Setting
Description
Name
Change the name of the component
Image
Add an image to your Card
Heading
Add a heading to your card, directly under the image
Description
Add a description to your card, directly under the heading
Subtext
A muted text which sits underneath your description.
Link Text
Add the text of your link to your card, directly under the description
Link URL
Activate your link with a URL
Link Color
Change the color of your link
Hover Color
Change the hover color of your link
Image Width
Set your image's width (in rem)
Card Width
Set the width of your Card
Card Height
Set the height of your Card