Back to components
Components

Help topic card

Displays a summary of a help topic or article, typically used in support sections to guide users toward relevant information.

Component

Topic title

Topic description

Props

Props Default Type
iconmdi:helpstring
titleTitlestring
descriptionDescriptionstring
to/string
buttonTextLearn morestring
buttonIconmdi:arrow-rightstring

Usage

icon

Sets the icon of the help topic.

 <template>
    <HelpTopicCard 
        icon="mdi:help"
    />
</template>
 

title

Sets the title of the help topic.

 <template>
    <HelpTopicCard 
        title="Topic title"
    />
</template>
 
  • Type: string
  • Default: 'Title'

description

Sets the description of the help topic.

 <template>
    <HelpTopicCard 
        description="Topic description"
    />
</template>
 
  • Type: string
  • Default: 'Description'

to

Sets the link to the help topic. Allows only internal links.

 <template>
    <HelpTopicCard 
        to="/"
    />
</template>
 
  • Type: string
  • Default: '/'

buttonText

Sets the text of the button.

 <template>
    <HelpTopicCard 
        buttonText="Learn more"
    />
</template>
 
  • Type: string
  • Default: 'Learn more'

buttonIcon

Sets the icon of the button.

 <template>
    <HelpTopicCard 
        buttonIcon="mdi:arrow-right"
    />
</template>
 
  • Type: string
  • Default: 'mdi:arrow-right'