Appearance

Custom Views ​

Custom Views let you add custom buttons and actions to your tables and records. You can create different types of views for different contexts and customize what actions are available to your users.

What are Custom Views? ​

Custom Views allow you to:

  • Add custom action buttons to your tables and forms
  • Create different experiences for different contexts
  • Extend your application with custom functionality
  • Provide users with specialized tools and workflows

Types of Custom Views ​

List Views ​

Add custom actions to your table views. These appear as buttons in the table toolbar and are perfect for:

  • Bulk operations (export all, update multiple records)
  • Creating new workflows
  • Generating reports
  • Custom data operations

Record Views ​

Add custom actions when viewing or editing individual records. These appear as buttons in the record header and are ideal for:

  • Record-specific operations
  • Integration with external systems
  • Custom workflows for individual items
  • Specialized tools for that record type

Dashboard Views ​

Add custom functionality to dashboard contexts for:

  • Analytics and reporting
  • Overview functionality
  • Custom visualizations
  • Summary operations

How Custom Views Work ​

Each table can have multiple custom views per type (list, record, or dashboard), but only the one with the highest order value will be displayed. Each custom view can contain multiple actions that appear as buttons in the interface.

Custom View Properties ​

  • Display Name: The name of your custom view
  • Description: What this view is for
  • Type: Whether it's for list, record, or dashboard contexts
  • Priority: Priority level (higher numbers take precedence)
  • Active Status: Whether the view is currently enabled

Action Properties ​

  • Name: Programmatic identifier for the action
  • Label: The text shown on the button (empty for icon-only)
  • Icon: Optional icon from the Lucide icon library
  • Position: The order in which actions appear
  • Type: The visual style of the button

Action Button Types ​

Custom views support four action types:

  • Primary: Blue buttons for main actions like "Generate Report"
  • Secondary: Gray buttons for supporting actions like "View Details"
  • Destructive: Red buttons for dangerous operations like "Delete All"
  • Outline: Outlined buttons for neutral actions and toggles

For detailed information about designing and using view actions, see the View Actions guide.

Configuration Options ​

In addition to custom actions, Custom Views support configuration options that let you customize the behavior of existing interface elements. These configurations are stored in the code field of your custom view.

Hiding Default Actions ​

You can hide default actions from appearing in your table toolbar using the hideActions configuration:

json
{
  "table": {
    "hideActions": ["export"]
  }
}

Available Actions to Hide ​

  • export - Hides the CSV export button from the table toolbar
  • More actions will be supported in future updates

Example: Hiding the Export Button ​

To create a custom view that hides the export functionality:

  1. Create a new custom view for your table
  2. Set the type to "list"
  3. In the code field, add:
    json
    {
  "table": {
    "hideActions": ["export"]
  }
}
  4. Activate the custom view

Users will no longer see the export button in the table toolbar for that table.

Configuration Structure ​

The configuration object supports the following structure:

json
{
  "table": {
    "hideActions": ["action1", "action2"]
  }
}
  • table.hideActions: Array of action names to hide from the interface

Creating Custom Views ​

Custom Views are created and managed through the platform's admin interface. You can:

  1. Create a new custom view for any table
  2. Choose the view type (list, record, or dashboard)
  3. Add custom actions with names, icons, and styling
  4. Configure the behavior of each action
  5. Activate the view to make it available to users

Once created, your custom views will automatically appear in the appropriate locations throughout your application.

Examples ​

Enhanced User Management ​

Create a list view for your Users table with these custom actions:

Actions you might add:

  • Export Users - Download user data as CSV
  • Send Welcome Emails - Email all new users
  • Generate Report - Create user analytics
  • Bulk Update - Update multiple users at once

Enhanced Order Processing ​

Create a record view for individual Orders with these actions:

Actions you might add:

  • Send Invoice - Email invoice to customer
  • Track Shipment - Open shipment tracking
  • Process Refund - Start refund workflow
  • Duplicate Order - Create a copy of this order

Where Custom Views Appear ​

List Views ​

Your custom list actions appear in the table toolbar, alongside the standard Filter, Export, and New buttons. Users will see your custom actions whenever they're viewing the table.

Record Views ​

Your custom record actions appear in the record header, alongside the standard Update and Delete buttons. Users will see these actions when viewing or editing individual records.

Dashboard Views ​

Your custom dashboard actions appear in dashboard contexts, providing specialized functionality for overview and analytics scenarios.

Best Practices ​

Designing Great Actions ​

  • Use clear names - "Export Users" is better than "Export"
  • Choose the right type - Use primary for main actions, destructive for dangerous ones
  • Add helpful icons - Icons make actions easier to recognize
  • Order logically - Put the most important actions first

User Experience ​

  • Keep it simple - Don't overwhelm users with too many actions
  • Be consistent - Use similar patterns across different tables
  • Provide feedback - Let users know when actions are successful
  • Consider permissions - Only show actions users are allowed to use

Security & Safety ​

  • Use destructive styling for dangerous actions like delete or reset
  • Confirm dangerous actions with dialogs or confirmations
  • Respect user permissions - only show actions users can actually perform
  • Validate inputs if your actions accept user data

Common Questions ​

Why aren't my actions showing up? ​

  • Make sure your custom view is active
  • Check that all actions are also active
  • Verify you're looking in the right place (list actions appear in table toolbars, record actions appear in record headers)
  • Check if another custom view has a higher priority value - only the highest priority view is displayed

Can I have multiple custom views for the same table? ​

Yes, you can create multiple custom views of the same type for a table, but only the one with the highest order value will be displayed. The system automatically selects the custom view with the highest priority.

How do I control which custom view is displayed? ​

Use the priority field when creating custom views. Views with higher priority numbers take precedence. For example, a view with priority 200 will be displayed instead of a view with priority 100.

How do I change the order of my actions? ​

Use the position field when creating actions. Lower numbers appear first (position 1 comes before position 2).

What icons are available? ​

The platform includes hundreds of icons. Common ones include:

  • download, upload, file-down, file-up
  • mail, phone, message-circle
  • edit, copy, trash, archive
  • eye, settings, filter
  • plus, minus, x

Can I style my action buttons? ​

Yes! Choose from four button types:

  • Primary (blue) for main actions
  • Secondary (gray) for supporting actions
  • Destructive (red) for dangerous actions
  • Outline (outlined border) for neutral actions

For icon-only buttons, simply leave the label empty. See the View Actions guide for detailed design guidance and examples.

How do I handle user permissions? ​

Custom views respect your existing permission system. Users will only see actions they're allowed to perform based on their role and permissions.