Buma UI - DocumentationBuma UI - Documentation
Get Started
Foundations
Components
Resources
Patterns
Data Visualization
Back to BSpace
Get Started
Foundations
Components
Resources
Patterns
Data Visualization
  • stacksFoundations
    • 💡 Overview
    • Color
    • Principle
    • Typography
  • brickComponents
    • 💡 Overview
    • Accordion
    • Alert
    • Avatar
    • Badge
    • Bottom Sheet
    • Bread Crumb
    • Button
    • Button Link
    • Button Navigation
    • Calendar
    • Card
    • Chat
    • Checkbox
    • Chips
    • Choice Tile
    • Comment
    • Date Picker
    • Divider
    • Download
    • Drawer
    • Dropdown
    • Empty State
    • Floating Button
    • Form Input
    • Header
    • Hint
    • Icon
    • List Choice
    • Loading
    • Modal
    • Navigation Bar
    • Notification
    • Pagination
    • Progress Bar
    • Radio Button
    • Search
    • Scrolling Bar
    • Segmented Switch
    • Side Menu
    • Side Tab
    • Slider
    • Switch
    • Tab
    • Table
    • Text Area
    • Text Input
    • Time Picker
    • Title
    • Toast
    • Tooltip
    • Wizzard
  • splitscreenPattern
    • 💡 Overview
    • Filter
      upcoming
    • Form
      upcoming
    • Notification
    • PWA
      upcoming
    • table
      upcoming
    • Upload Download
      upcoming
  • insert_chartData Visualization
    • 💡 Overview
    • Tiering
    • Pattern
    • Chart and Graph
      • Chart Selection Guide
      • Map Selector
      • Donut Chart
      • Donut Progress Bar Chart
      • Spider Chart
      • Line Chart
      • Chart Area
      • Speedometer
      • Heat Map
      • Scatter Plot
      • Pie Chart
      • Bar Chart
      • Waterfall Chart
      • Sunburst Chart
      • Tree Decomposition Chart
      • Scorecards
      • Table
      • Micro Visualization
    • Typography
    • Color Palette
  • data_objectTokens
    upcoming
  • inventory_2Resources
    • 💡 Overview
    • Mobile
      new
      • 💡 Introduction
      • Installation
      • General
        • Important Rules
        • Naming Convention
        • Clean Architecture
    • Web
      upcoming
ComponentsTitleThe title component refers to a graphical element used to display a prominent heading or label within a user interface.
Guidelines
Design
v2.5.0
Updated
Vue
v2.0.0
Updated
Flutter
v2.0.0
Updated

Anatomy

The core of the Title component, which displays the page title.
A smaller, descriptive text that provides additional context or information about the page.
A navigational aid that helps users understand their location within the system and navigate back to previous sections.
The core of the Title component, which displays the page title.
A decorative element used to create visual separation between sections of content, enhancing the layout without implying any structural hierarchy.
An interactive element that can be optionally included with the Title component to provide actions related to the page title or context.
Title Variant
Header Title

Used as the main Title, which serves as the main header on each page.

Header Section Title

Used within the Card, which provides titles for specific content within the Card component.


Usage

The Title component is a key element used for headers on each page. It ensures consistency in the presentation of page titles across the system.

Usage Recommendation:

  • Providing clear and descriptive headings or labels for various sections, pages, or elements.
  • Convey essential information and provide context to users.
  • Enhancing navigation and comprehension throughout the interface.


Accessibility

This title component is designed to ensure consistency in typography and spacing across all pages, so that every title on different pages maintains a uniform and well-structured appearance. It is important not to change the text size or spacing, as doing so may disrupt the overall visual consistency and user experience across the site.

Do's
Don't


Content

Titles should clearly communicate the purpose or main content of the page.

Capitalization

It is essential to use title case for all titles, ensuring they maintain a formal and consistent appearance.

Do's
Don't
Usage on BSpace
Header Title

The header title is used to display the main title of a page with additional subtitle and relevant button links.

The title component can be switched to a Progressive Web App (PWA) format. This ensures that the title remains consistent and user-friendly across both desktop and mobile platforms.

Header Section Title

No button is present near the title, suggesting that the section is either static or for informational purposes only, without options for immediate interaction or management by the user.

With button (typically labeled "Manage," "Edit," or similar) placed near the title. This button allows users to interact with or manage the section's content, providing options such as editing, adding, or deleting items. Also, the button can serve as a link to redirect users to another page for more detailed management or further actions related to the section.

The title header section component can be switched to a Progressive Web App (PWA) format. This ensures that the title header section remains consistent and user-friendly across both desktop and mobile platforms.

Web
Resources You can use these components by accessing the provided resource files.

Usage of BTitle

The package is already installed in the repository's shell. To use the component, you only need to add the following code:

<BTitle />

Attributes of BTitle

If there is a question mark ? in the Data Type, it means that the properties are optional.

PropertiesData TypeDescriptionDefault Value
titlestringText for the titleTitle Text
titleClassstringCustom class to style the titlenone
breadcrumbItems?stringBreadcrumb text for hierarchical navigationnone

Variants

The <BTitle /> component supports the following variants:

VariantDescription
labelLabel used for show target label
targetA target variant to link to a destination

Usage of BTitleSection

The package is already installed in the repository's shell. To use the component, you only need to add the following code:

<BTitleSection />

Attributes of BTitleSection

If there is a question mark ? in the Data Type, it means that the properties are optional.

PropertiesData TypeDescriptionDefault Value
titlestringText for the titleTitle Text
titleClassstringCustom class to style the titlenone
hideButton?booleanDetermines if the action button should be hiddentrue
buttonVariantstringVariant for the action buttonsecondary
buttonLabelstringLabel text for the action buttonAction
buttonClassstringCustom class for styling the action buttonnone

Variants

The <BTitleSection /> component supports the following variants:

VariantDescription
primaryUsed for primary or important actions within an interaction.
secondaryDefault style recommended for most actions.
arrow_back
Previous Time Picker
Next Toast
arrow_forward