Skip to content

Documentation shows incorrect field names for header custom buttons #25

@cameo-js

Description

@cameo-js

Description

The documentation in theming-customization.mdx shows incorrect field names for header custom buttons. The documentation uses customButtonLeft and customButtonRight, but the actual TypeScript interface in the source code uses leftAction and rightAction.

Current Documentation (Incorrect)

header: {
  customButtonLeft: {
    icon: "settings-cog",
    onClick: () => openProfileSettings(),
  },
  customButtonRight: {
    icon: "home",
    onClick: () => openHomePage(),
  },
},

Actual TypeScript Interface (Correct)

header: {
  leftAction: {
    icon: "settings-cog",
    onClick: () => openProfileSettings(),
  },
  rightAction: {
    icon: "home",
    onClick: () => openHomePage(),
  },
},

Impact

Developers following the documentation will encounter errors

Expected Behavior

The documentation should use the correct field names that match the actual TypeScript interface:

  • customButtonLeftleftAction
  • customButtonRightrightAction

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions