Creating and Publishing Spaces

Creating and Publishing Spaces

Click on “+ Create New Space” in the left navigation panel to get started.

Designing your space

When you first create a space, you’ll see an empty header section and “Untitled Space” in the top bar, along with a blank canvas for designing your tool. You can click on the edit icon in the top bar to change the name of your space - this name will appear in the left navigation bar. 

Then, you can add text to your header to let users know what the space is for, like "Customer Lookup" or "Inventory List". 

Next, you’ll build out your tool by adding and configuring components. Click on the components icon in the left navigation to select a component. In your canvas area, you can place and resize the component as desired. Use the trash icon to remove a component from your canvas. 

In the header, you’ll also see a purple “+” icon. Clicking this will allow you to place the following components in the header area:

Additionally, some components can be placed in-line within another component. Tables, detail views, and card lists support the following components placed in-line; simply add the component as a field/column in configuration:

Once you’ve placed your components, clicking on any element will bring up its configuration options in the right panel - see the docs for each component for more details on configuration.

If you’d like to place a component within another component, it’s best to configure this as an in-line component within another component, rather than placing two components on top of each other and binding them. This will avoid any formatting issues if the user resizes the window, and keeps configuration clear and simple.

For example, instead of placing a button component on top of a detail view and configuring them to work together, you can simply configure an in-line button as one of the fields of a detail view.

Saving as draft

If you’re not ready to publish your space, you can always save it as a draft. (If you haven’t done so already, make sure to name your Space first. This can be done from the top navigation bar.)

Internal will let you know when you have unsaved changes with an indicator at the top-left of the page. Hover over it to reveal a “Save” button.

Note: If you see an error indicating that changes could not be saved, you are likely missing a header, Space name, or there is an issue with a component’s configuration. You will need to resolve these issues before saving.

Publishing your Space

When you’re ready to publish your Space (making it available to your users), click on the Publish button on the top left. You’ll see a list of environments available for you to publish to (if no new environments have been created, you’ll see a single default environment).

Check the environments that you want to publish to and click Publish. Publishing will first save your draft and then publish it. 

Any unpublished drafts can be accessed from the bottom of your left navigation panel - click on “Unpublished Spaces” to view.