Skip to main content

Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models

Syntax

Summary

Represents a custom contextual menu option.

Remarks

Custom options require ContextualOptionConfig.Title, ContextualOptionConfig.Description, and ContextualOptionConfig.Href. See https://www.mintlify.com/docs/ai/contextual-menu.

Examples

Constructors

.ctor

Syntax

.ctor Inherited

Inherited from object

Syntax

Properties

Description

Gets or sets the option description shown beneath the title when the menu expands.

Syntax

Property Value

Type: string?

Href

Gets or sets the destination URL or URL template.

Syntax

Property Value

Type: Mintlify.Core.Models.ContextualHrefConfig?

Remarks

A string for a simple link, or an object with base and query for dynamic links. Query values may use $page, $path, and $mcp placeholders.

Icon

Gets or sets the option icon.

Syntax

Property Value

Type: Mintlify.Core.Models.IconConfig?

Title

Gets or sets the option title.

Syntax

Property Value

Type: string?

Methods

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?