Skuid Docs
    Skuid Docs
  • Concepts
  • Reference
  • Site Administration
  • Tutorials
  • Release Notes
v15.3.6
2
https://docs.skuid.com/v15.3.6/v2/en/
False
  • Concepts
    • Data
      • Authentication Providers and Data Sources
      • Authentication and Skuid
      • Callback URLs/Redirect URIs
      • Data Source Objects
      • Google
        • Google Calendar
        • Google Drive
      • Salesforce
      • SQL
      • REST
        • URL Merge Condition Example
      • OData
        • Create, update, and delete records from SQL Server
      • Troubleshooting
    • Build
      • The Composer
      • The Page Index
      • Context
      • Pages
        • API Versioning in Skuid
          • v2 Page API Migration Utility
        • Create and Customize Skuid Pages
        • Principal and Dependent Pages
        • Page Revisions
        • Optimize Pages
        • Page Packs
        • Modules
        • Page Parameters
      • Models
        • Create and Configure Models
        • Model Conditions
          • Limit Records with a Subquery Condition
        • Model Actions
        • Include Child Fields in a Parent Object
        • Aggregate Models
          • Aggregations in Table and Chart Components
          • An Aggregation Case Study
        • Using Fields
          • UI-Only Fields and Models
            • UI-Only Field Use Cases
          • Field Metadata Overrides
      • Components
        • Layout
          • Accordion
          • Button Set
            • Create a Show/Hide Toggle Button
          • Carousel
          • Masthead
          • Navigation
          • Responsive Grid
          • Tab Container
          • Tab Set
          • Vertical Navigation
          • Wizard
            • Create a New Account Wizard
          • Wrapper
        • Data
          • Calendar
          • Deck
          • File Upload
          • Filter Set
          • Form
          • Header
          • Image
            • Add a Record-Sensitive Image
          • List
          • Message Area
          • Search
            • Creating Search Form and Search Results Pages
          • Table
          • Text
        • Advanced
          • Chatter Feed
          • Page Include
        • Visualizations
          • Before You Chart
          • Chart
          • Geochart
          • Enhancing Charts with Actions
        • Component Accessories
          • Add Drawers to a Table or List
          • Modals
            • Use a Modal to Create New Records
          • Sliding Panels
          • Sort Builder
        • Display Logic
      • Best Practices
        • Page Performance Guide
        • Skuid and Salesforce Lightning Performance Tips
        • Working with Images
      • Debugging Skuid in the Console
      • Logic
        • Filters
          • Filter on Date Ranges
          • Filter on Numeric Ranges
          • Create a Selectable Filter
            • Use Select option to Filter on Date Ranges
            • Use Select option to Filter on a Number Range
            • Use Select option with Builder-generated Options
            • Use Select option with Multiple Conditions and Fields
          • Create a Toggle Filter
          • Filter by Related Objects
        • Action Framework
          • Actions Reference
            • Visual Navigation
            • Model Conditions / Querying Actions
            • Model Data Changes Actions
            • Data Source Specific Actions
            • Platform Actions
            • Logic Actions
            • Voice Actions
            • Component-Context Actions
          • Action Sequences
            • Inputs How-To: Activate and Set a Condition and Requery Model
        • Merge Syntax
          • Global Merge Variables / Functions
          • Row Merge Variables
          • Data source Merge API Reference
        • Skuid and Date/Time
        • Client-Side Validation
    • Style
      • Design System Studio
        • Property Reference
        • Lightning in Skuid
        • Fonts in the Design System Studio
        • Extending Design Systems with Code
      • Label Localization
    • Deploy
      • Salesforce Lightning
      • Salesforce Classic
        • skuid:page Visualforce component
        • Salesforce Dashboards
        • Force.com Sites
      • Page Assignments
      • Salesforce Communities
      • Sandboxes and Connected Orgs
      • License and Permission Assignments
      • ISV and Managed Packages
      • Skuid and the Salesforce Guest User
    • Extend
      • Skuid and Code
        • Skuid and JavaScript
          • Resource Types
          • UI Code
            • Custom Field Renderers
              • Basic virtual-based field renderer
              • Native Date Renderer
              • jQuery Mask
              • Ratings Icons
              • Embedded YouTube Player
        • Salesforce Languages
          • Skuid and Apex
            • Apex Triggers
            • Invocable Methods and the Apex Data Source Action
            • Remote Actions
            • Access Apex as a REST data source
            • Access Web Services using the AJAX Toolkit
          • Skuid and Aura
        • Skuid and Analytics
      • CI/CD with Skuid
      • Automated Testing
        • Example Automated Test with Node.js, Selenium, and Jasmine
  • Reference
    • The Property Library
    • API Reference
      • skuid.debug
      • 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.lightning
        • 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
    • Page XML API
    • skuid-sfdx
    • Skuid Metadata Object Reference
      • Authentication providers
      • Data sources
      • Design Systems
      • Files
      • Pages
      • Themes
    • Skuid Glossary
    • Formula and Function Reference
    • Skuid and Date/Time
    • Open Source Software Attributions
  • Site Administration
    • Installing Skuid SFX
    • Upgrading Skuid SFX
    • Deprecated in Skuid
    • Content Delivery Network
    • Supported Browsers
    • Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
    • Skuid VPAT for v2
  • Tutorials
    • Skuid Page Tutorials
      • Build a Custom List Page
      • Build a Custom Detail Page
      • Compose a Branded Header and Navigation
      • Compose a One-Page App Using Tab Actions and Conditional Rendering
      • Conditionally Display Fields
      • 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: Granting Login Rights to your Org
      • Reclaim the Salesforce Home Page
      • Add and Display Images for a Single Record
    • JavaScript Tutorials
      • Using Skuid with JavaScript: A Primer
  • Legal terms and conditions
  • Skuid SFX Evaluation Guide
    • Overview​
      • What Is Skuid?
      • What are the benefits of Skuid?
      • How does Skuid maximize my Salesforce investment?
      • When is Skuid a good fit?
      • When is Skuid not a good fit?
      • Who uses Skuid?
      • What do customers say about us?
      • What steps does Skuid take to ensure compatibility with future Salesforce releases?
    • Developing Apps with Skuid​
      • The Scalable Kit for User Interface Design (Skuid)
        • Models
        • UI components
        • The Action Framework
        • Display Logic
        • Event System
        • Design System Studio
        • Code Extension
      • The Salesforce Ecosystem​
        • Does Skuid work with Lightning?
        • Does Skuid work with Salesforce Experience Cloud?
        • Is Skuid compatible with other AppExchange apps?
        • What Salesforce products and services does Skuid support?
      • Mobile
    • App Lifecycle Management​
      • Can I build with Skuid in different production environments?
      • Can my entire team develop with Skuid?
      • How does Skuid fit into my company’s CI/CD practices?
      • Analytics​
        • Does Skuid work with my third-party analytics software?
        • Does Skuid work with Einstein Analytics?
        • Build your own analytics tracker with Skuid
    • Architecture​
      • Skuid SFX Architecture
        • How does Skuid work?
        • How does Skuid get data and does Skuid consume API calls?
        • Is Skuid limited to one sObject or Record Type per page?
        • Does my Salesforce application have to be built completely from Skuid?
        • How does Skuid work with Salesforce Process automation and validation?
      • Lightning​
        • How do Skuid pages work in Lightning?
        • Where else in Lightning can I use Skuid?
        • Can I use Lightning components in Skuid pages?
      • Salesforce Classic​
        • How do Skuid pages work in Salesforce Classic?
        • Where else in Classic can I use Skuid?
        • What happens if I need to migrate to Lightning after building with Skuid in Classic?
    • Data​
      • Skuid and the Salesforce data model
      • Can Skuid Access…​
        • Objects?
        • Object Relationships?
        • Salesforce field types?
        • Custom settings?
        • Custom metadata?
        • Big Objects?
        • External Objects?
        • Other Salesforce Orgs?
    • Security​
      • Does Skuid store my Salesforce or third-party data?
      • How does Skuid work with Salesforce permission sets, sharing rules, field-level security, and profiles?
      • Does Skuid override Salesforce validation rules and error messages?
      • What security certifications does Skuid have?
    • Performance​
      • Does Skuid have data limits?
      • How can Skuid builders optimize for page performance?
  • Header
    • Using the Header Component
      • Skuid SFX
    • Properties
      • Component properties
        • General tab [[]]
        • Advanced tab [[]]
        • Styles tab [[]]
        • Display logic tab [[]]
        • Nested elements
          • Button properties [[]]

In This Section

  • Concepts
    • Data
      • Authentication Providers and Data Sources
      • Authentication and Skuid
      • Callback URLs/Redirect URIs
      • Data Source Objects
      • Google
        • Google Calendar
        • Google Drive
      • Salesforce
      • SQL
      • REST
        • URL Merge Condition Example
      • OData
        • Create, update, and delete records from SQL Server
      • Troubleshooting
    • Build
      • The Composer
      • The Page Index
      • Context
      • Pages
        • API Versioning in Skuid
          • v2 Page API Migration Utility
        • Create and Customize Skuid Pages
        • Principal and Dependent Pages
        • Page Revisions
        • Optimize Pages
        • Page Packs
        • Modules
        • Page Parameters
      • Models
        • Create and Configure Models
        • Model Conditions
          • Limit Records with a Subquery Condition
        • Model Actions
        • Include Child Fields in a Parent Object
        • Aggregate Models
          • Aggregations in Table and Chart Components
          • An Aggregation Case Study
        • Using Fields
          • UI-Only Fields and Models
            • UI-Only Field Use Cases
          • Field Metadata Overrides
      • Components
        • Layout
          • Accordion
          • Button Set
            • Create a Show/Hide Toggle Button
          • Carousel
          • Masthead
          • Navigation
          • Responsive Grid
          • Tab Container
          • Tab Set
          • Vertical Navigation
          • Wizard
            • Create a New Account Wizard
          • Wrapper
        • Data
          • Calendar
          • Deck
          • File Upload
          • Filter Set
          • Form
          • Header
          • Image
            • Add a Record-Sensitive Image
          • List
          • Message Area
          • Search
            • Creating Search Form and Search Results Pages
          • Table
          • Text
        • Advanced
          • Chatter Feed
          • Page Include
        • Visualizations
          • Before You Chart
          • Chart
          • Geochart
          • Enhancing Charts with Actions
        • Component Accessories
          • Add Drawers to a Table or List
          • Modals
            • Use a Modal to Create New Records
          • Sliding Panels
          • Sort Builder
        • Display Logic
      • Best Practices
        • Page Performance Guide
        • Skuid and Salesforce Lightning Performance Tips
        • Working with Images
      • Debugging Skuid in the Console
      • Logic
        • Filters
          • Filter on Date Ranges
          • Filter on Numeric Ranges
          • Create a Selectable Filter
            • Use Select option to Filter on Date Ranges
            • Use Select option to Filter on a Number Range
            • Use Select option with Builder-generated Options
            • Use Select option with Multiple Conditions and Fields
          • Create a Toggle Filter
          • Filter by Related Objects
        • Action Framework
          • Actions Reference
            • Visual Navigation
            • Model Conditions / Querying Actions
            • Model Data Changes Actions
            • Data Source Specific Actions
            • Platform Actions
            • Logic Actions
            • Voice Actions
            • Component-Context Actions
          • Action Sequences
            • Inputs How-To: Activate and Set a Condition and Requery Model
        • Merge Syntax
          • Global Merge Variables / Functions
          • Row Merge Variables
          • Data source Merge API Reference
        • Skuid and Date/Time
        • Client-Side Validation
    • Style
      • Design System Studio
        • Property Reference
        • Lightning in Skuid
        • Fonts in the Design System Studio
        • Extending Design Systems with Code
      • Label Localization
    • Deploy
      • Salesforce Lightning
      • Salesforce Classic
        • skuid:page Visualforce component
        • Salesforce Dashboards
        • Force.com Sites
      • Page Assignments
      • Salesforce Communities
      • Sandboxes and Connected Orgs
      • License and Permission Assignments
      • ISV and Managed Packages
      • Skuid and the Salesforce Guest User
    • Extend
      • Skuid and Code
        • Skuid and JavaScript
          • Resource Types
          • UI Code
            • Custom Field Renderers
              • Basic virtual-based field renderer
              • Native Date Renderer
              • jQuery Mask
              • Ratings Icons
              • Embedded YouTube Player
        • Salesforce Languages
          • Skuid and Apex
            • Apex Triggers
            • Invocable Methods and the Apex Data Source Action
            • Remote Actions
            • Access Apex as a REST data source
            • Access Web Services using the AJAX Toolkit
          • Skuid and Aura
        • Skuid and Analytics
      • CI/CD with Skuid
      • Automated Testing
        • Example Automated Test with Node.js, Selenium, and Jasmine
  • Reference
    • The Property Library
    • API Reference
      • skuid.debug
      • 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.lightning
        • 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
    • Page XML API
    • skuid-sfdx
    • Skuid Metadata Object Reference
      • Authentication providers
      • Data sources
      • Design Systems
      • Files
      • Pages
      • Themes
    • Skuid Glossary
    • Formula and Function Reference
    • Skuid and Date/Time
    • Open Source Software Attributions
  • Site Administration
    • Installing Skuid SFX
    • Upgrading Skuid SFX
    • Deprecated in Skuid
    • Content Delivery Network
    • Supported Browsers
    • Using the Keyboard: Shortcuts, Hotkeys, and Accessibility
    • Skuid VPAT for v2
  • Tutorials
    • Skuid Page Tutorials
      • Build a Custom List Page
      • Build a Custom Detail Page
      • Compose a Branded Header and Navigation
      • Compose a One-Page App Using Tab Actions and Conditional Rendering
      • Conditionally Display Fields
      • 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: Granting Login Rights to your Org
      • Reclaim the Salesforce Home Page
      • Add and Display Images for a Single Record
    • JavaScript Tutorials
      • Using Skuid with JavaScript: A Primer
  • Legal terms and conditions
  • Skuid SFX Evaluation Guide
    • Overview​
      • What Is Skuid?
      • What are the benefits of Skuid?
      • How does Skuid maximize my Salesforce investment?
      • When is Skuid a good fit?
      • When is Skuid not a good fit?
      • Who uses Skuid?
      • What do customers say about us?
      • What steps does Skuid take to ensure compatibility with future Salesforce releases?
    • Developing Apps with Skuid​
      • The Scalable Kit for User Interface Design (Skuid)
        • Models
        • UI components
        • The Action Framework
        • Display Logic
        • Event System
        • Design System Studio
        • Code Extension
      • The Salesforce Ecosystem​
        • Does Skuid work with Lightning?
        • Does Skuid work with Salesforce Experience Cloud?
        • Is Skuid compatible with other AppExchange apps?
        • What Salesforce products and services does Skuid support?
      • Mobile
    • App Lifecycle Management​
      • Can I build with Skuid in different production environments?
      • Can my entire team develop with Skuid?
      • How does Skuid fit into my company’s CI/CD practices?
      • Analytics​
        • Does Skuid work with my third-party analytics software?
        • Does Skuid work with Einstein Analytics?
        • Build your own analytics tracker with Skuid
    • Architecture​
      • Skuid SFX Architecture
        • How does Skuid work?
        • How does Skuid get data and does Skuid consume API calls?
        • Is Skuid limited to one sObject or Record Type per page?
        • Does my Salesforce application have to be built completely from Skuid?
        • How does Skuid work with Salesforce Process automation and validation?
      • Lightning​
        • How do Skuid pages work in Lightning?
        • Where else in Lightning can I use Skuid?
        • Can I use Lightning components in Skuid pages?
      • Salesforce Classic​
        • How do Skuid pages work in Salesforce Classic?
        • Where else in Classic can I use Skuid?
        • What happens if I need to migrate to Lightning after building with Skuid in Classic?
    • Data​
      • Skuid and the Salesforce data model
      • Can Skuid Access…​
        • Objects?
        • Object Relationships?
        • Salesforce field types?
        • Custom settings?
        • Custom metadata?
        • Big Objects?
        • External Objects?
        • Other Salesforce Orgs?
    • Security​
      • Does Skuid store my Salesforce or third-party data?
      • How does Skuid work with Salesforce permission sets, sharing rules, field-level security, and profiles?
      • Does Skuid override Salesforce validation rules and error messages?
      • What security certifications does Skuid have?
    • Performance​
      • Does Skuid have data limits?
      • How can Skuid builders optimize for page performance?

In This Topic

  • Header
    • Using the Header Component
      • Skuid SFX
    • Properties
      • Component properties
        • General tab [[]]
        • Advanced tab [[]]
        • Styles tab [[]]
        • Display logic tab [[]]
        • Nested elements
          • 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, add a one to the page. Next, set properties:

  • 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 SFX¶

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¶

(Just need to look up a property? Try going directly to the Property Library.)

Component properties¶

General 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.
  • Heading level: Indicates the hierarchical position for this Header component relative to others on the page, with 1 being the highest level. In effect, this wraps the Header’s title in HTML tags. Heading Level 1 = <h1> tags; Heading Level 2 = <h2> tags, and so on. This helps assistive technologies correctly navigate the page using the Header components as outline levels.

Note

Changing this property does not change the visual appearance of the component. Visual styles are set in the Design System.

  • ARIA role: Determines which type of user interface element the component represents for assistive technology. The available options all refer to standard landmark ARIA roles. For more technical information on each role type, refer to MDN web docs.
    • Banner: Used for defining global site details, such as company name, global search, logos, and similar information.
    • Complementary: Used for content that, while related to the main content area, is not necessary for that main area to stand alone. Typically used for sidebars and other supplementary information.
    • Content Info: Used for footers that appear on each page, which typically contain copyright information, navigation items, or similar content.
    • Form: Used to identify sections that comprise a singular form–even though it may be comprised of multiple components.
    • Main: Used to identify primary focus of the page.
    • Navigation: Used to indicate a section containing links for navigating a site.
    • Region: Used as a more generic landmark in order to indicate an area is relevant, but not categorized under the other available roles.
    • Search: Used to indicate a section contains elements for searching the page or site.

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.

Note

To refresh available style variant options, click refresh Refresh style variants.

This is useful for when changes to the design system (like style variants or variable options) have been made in another browser window or by another user.

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

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

Display logic tab [[]]¶

Standard display logic options are available to display or hide the component or feature.

Nested elements¶

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 Dec 06, 2024.

Documentation

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

Resources

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

© 2024 Skuid, Inc.

Terms of Use | Privacy Policy | Legal Terms and Conditions