Skuid Docs
    Skuid Docs
  • Concepts
  • Reference
  • Site Administration
  • Tutorials
  • Release Notes
v12.1.1
2
https://docs.skuid.com/v12.1.1/v2/en/
False
  • <no title>
  • <no title>
  • Guides
    • Get Started with Skuid
      • Composing in Skuid: a Deep Dive
    • Skuid Platform: Quickstart
      • Creating a data source connection in Skuid Platform
      • Tour of Skuid Platform
      • Skuid Platform Subscriptions and Usage
    • <no title>
    • The App Composer
    • Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
    • Debugging Skuid in the Console
    • Best Practices
      • Upgrading Skuid on Salesforce
      • Page Performance Guide
      • Skuid and Salesforce Lightning Performance Tips
      • One Save Button Per Page
      • Styling Best Practices
  • Tutorials
    • Skuid Page Tutorials
      • Add Related Lists with the Table Component
      • Build an Activities Related List Tab
      • Build a Custom “Create New Record” Page
      • Build a Custom Detail Page
      • Build a Custom List Page
      • Compose a Branded Header and Navigation
      • Compose a One-Page App Using Tab Actions and Conditional Rendering
      • Conditionally Display Fields
      • Create a Custom Clone Page
      • Create a Custom “Clone Account” page
      • Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
      • Mass Create Records
      • Show Products in an Opportunity Page
      • Skuid Pages for standard Salesforce CRM
    • Salesforce Tutorials
      • Add Product Line Items to Opportunities with a Popup
      • Add Gmail to Salesforce functionality in your email fields
      • Create a Custom Edit Page and Set Visualforce Overrides
      • Getting Help: Grant Skuid Login Rights to your Org
      • Reclaim the Salesforce Home Page
      • Redirect to Salesforce Processes
      • Skuid for Sales: A Turn-Key Template to Augment Lightning Sales Cloud
    • JavaScript Tutorials
      • Progress Indicator Component
      • Simple Map Component
      • Use a Snippet as a Filter Item Source to create “Dependent Filters”
      • Use Inline Javascript to Create a Slider Field Renderer
  • Legal terms and conditions
  • API Reference
    • skuid.runtime
      • skuid.$
      • skuid.actions
      • skuid.ajax
      • skuid.builder.core
      • skuid.builder.core.coreProps
      • skuid.calendar
      • skuid.collaboration
      • skuid.component
      • skuid.componentType
      • skuid.events
      • skuid.formula
      • skuid.hotkeys
      • skuid.label
      • skuid.load
      • skuid.model
      • skuid.model.Model
      • skuid.mustache
      • skuid.page
      • skuid.sfdc
      • skuid.snippet
      • skuid.time
      • skuid.utils
      • skuid.version
      • Component-Specific APIs
      • Skuid Model Metadata Object
      • Skuid Model Child Relationship Metadata Object
      • Skuid Model Condition Metadata Object
      • Skuid Model Field Metadata Object
      • Skuid Model Record Type Metadata Object
  • Header
    • Using the Header Component
      • Skuid on Salesforce
    • Properties
      • Header Properties
        • Basic Tab [[]]
        • Advanced tab [[]]
        • Styles tab [[]]
        • Display Logic tab [[]]
      • Button Properties

In This Section

  • <no title>
  • <no title>
  • Guides
    • Get Started with Skuid
      • Composing in Skuid: a Deep Dive
    • Skuid Platform: Quickstart
      • Creating a data source connection in Skuid Platform
      • Tour of Skuid Platform
      • Skuid Platform Subscriptions and Usage
    • <no title>
    • The App Composer
    • Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
    • Debugging Skuid in the Console
    • Best Practices
      • Upgrading Skuid on Salesforce
      • Page Performance Guide
      • Skuid and Salesforce Lightning Performance Tips
      • One Save Button Per Page
      • Styling Best Practices
  • Tutorials
    • Skuid Page Tutorials
      • Add Related Lists with the Table Component
      • Build an Activities Related List Tab
      • Build a Custom “Create New Record” Page
      • Build a Custom Detail Page
      • Build a Custom List Page
      • Compose a Branded Header and Navigation
      • Compose a One-Page App Using Tab Actions and Conditional Rendering
      • Conditionally Display Fields
      • Create a Custom Clone Page
      • Create a Custom “Clone Account” page
      • Highlight Critical Data: Wrappers, Rich Text, and Ui-Only Fields
      • Mass Create Records
      • Show Products in an Opportunity Page
      • Skuid Pages for standard Salesforce CRM
    • Salesforce Tutorials
      • Add Product Line Items to Opportunities with a Popup
      • Add Gmail to Salesforce functionality in your email fields
      • Create a Custom Edit Page and Set Visualforce Overrides
      • Getting Help: Grant Skuid Login Rights to your Org
      • Reclaim the Salesforce Home Page
      • Redirect to Salesforce Processes
      • Skuid for Sales: A Turn-Key Template to Augment Lightning Sales Cloud
    • JavaScript Tutorials
      • Progress Indicator Component
      • Simple Map Component
      • Use a Snippet as a Filter Item Source to create “Dependent Filters”
      • Use Inline Javascript to Create a Slider Field Renderer
  • Legal terms and conditions
  • API Reference
    • skuid.runtime
      • skuid.$
      • skuid.actions
      • skuid.ajax
      • skuid.builder.core
      • skuid.builder.core.coreProps
      • skuid.calendar
      • skuid.collaboration
      • skuid.component
      • skuid.componentType
      • skuid.events
      • skuid.formula
      • skuid.hotkeys
      • skuid.label
      • skuid.load
      • skuid.model
      • skuid.model.Model
      • skuid.mustache
      • skuid.page
      • skuid.sfdc
      • skuid.snippet
      • skuid.time
      • skuid.utils
      • skuid.version
      • Component-Specific APIs
      • Skuid Model Metadata Object
      • Skuid Model Child Relationship Metadata Object
      • Skuid Model Condition Metadata Object
      • Skuid Model Field Metadata Object
      • Skuid Model Record Type Metadata Object

In This Topic

  • Header
    • Using the Header Component
      • Skuid on Salesforce
    • Properties
      • Header Properties
        • Basic Tab [[]]
        • Advanced tab [[]]
        • Styles tab [[]]
        • Display Logic tab [[]]
      • Button Properties

Header¶

The Header component displays a title or subtitle, allowing you to provide context for the page, or for individual sections on the page. You can also add buttons that use the Action Framework to the header.

Note

While it’s possible to create buttons using the Header component, for maximum flexibility, Skuid recommends using Ink’s Button Set component.

Using the Header Component¶

Note

The content below assumes you have a Skuid page and at least one working model.

To use the Header component, just drag and drop one into a Skuid page and configure it:

  • Set Title and Subtitle properties by adding a specific string of text, by using the field picker to select and add merge variables for specific fields, or via a combination of the two. You may also leave either of these properties blank.

Note

To ensure the desired field is available for Titles and Subtitles, include that field in the model.

  • In the Header properties pane, decide whether you want a border separating the header from the next component, and adjust the component margins in the Styles tab.

Note

By default, margins are set to None, so title content will sit immediately adjacent to the left margin. Adjust this in the Styles tab, using the Left Margin property.

  • If desired, add buttons to trigger actions on the model.

Note

Skuid recommends using Ink’s Button Set component.

Skuid on Salesforce¶

Warning

You can add a custom Salesforce button type to the Button Set component. However, if you deploy a Skuid page with that Button Set within the Salesforce Support Service Cloud, unexpected functionality may result.

Properties¶

Header Properties¶

Basic Tab [[]]¶

  • Model: The model the Header is connected to, providing fields and context to any merge variables used in the Title and Subtitle properties.
  • Title: The text to be displayed as a top-level heading within the component. This property can be a specific string of text, the merge variables of one or more fields chosen with the field picker, or a combination of the two.
  • Subtitle: The text to be displayed as a second-level heading above the title. This property can be a specific string of text, the merge variables of one or more fields chosen with the field picker, or a combination of the two.
  • Add border separator: Adds a thin rule at the bottom of the component to visually separate it from the component that follows.

Advanced tab [[]]¶

  • Unique Id (optional): Skuid automatically generates an alphanumeric Id for the component; if preferred, give it a practical name.

Styles tab [[]]¶

Global styles for this component are set in the Design System Studio. The following Style properties can be adjusted for an individual page.

  • Style Variant: The font sizing for Titles and Subtitles is set in the theme using the Design System Studio. To adjust sizes in a specific instance, use the Style Variant. Options are:

    • Default
    • Small
    • Medium
    • Large
    • Extra Large
    • Huge
    • Gigantic

    Note

    These sizes are relative to the baseline determined by the Design System settings.

  • Spacing: Sets the spacing of the Header relative to other components on the page. Spacing can be managed for Top Margin, Bottom Margin, Left Margin, Right Margin. All margins can be set to one of the following:

    • None
    • Extra Small
    • Small
    • Reduced
    • Regular
    • Increased
    • Large
    • Extra Large
    • Huge

    Note

    These sizes are relative to one another; the baseline is determined by Design System settings.

Display Logic tab [[]]¶

Standard display logic options are available.

Button Properties¶

When you add buttons to the Header component, these buttons have their own properties. All Header button properties are the same as those for Ink Button Set buttons.

Back to top

Last updated on Sep 01, 2022.

Documentation

  • Concepts
  • Reference
  • Site Administration
  • Tutorials
  • Release Notes

Resources

  • Skuid Skool
  • Community
  • Support
  • Contact
  • Skuid
Start building for free

© 2022 Skuid, Inc.

Terms of Use | Privacy Policy | Legal Terms and Conditions