# UserColumnMenuItem

Canonical page: https://www.adaptabletools.com/docs/reference/usercolumnmenuitem

Column Menu Item that is provided by User

```ts title="TypeScript"
export interface UserColumnMenuItem 
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [disabled](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#disabled) | `boolean` | Whether menu item is disabled |
| [frameworkComponent](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#frameworkcomponent) | [`MenuItemFrameworkComponent`](https://www.adaptabletools.com/docs/reference/menuitemframeworkcomponent.md)`<`[`ColumnMenuContext`](https://www.adaptabletools.com/docs/reference/columnmenucontext.md)`>` | Optional Framework Component (React, Angular or Vue) used to render the<br/>content of this menu item.<br/><br/>When supplied, AG Grid renders the component inside the menu row using<br/>its own framework adapter. The component receives AG Grid&#39;s<br/>`CustomMenuItemProps`, with the AdapTable-specific extras<br/>(`adaptableApi`, `menuContext`, plus anything passed via<br/>`menuItemParams`) available as `props.menuItemParams`.<br/><br/>Supported in the React, Vue and Angular variants of AdapTable.<br/><br/>For Vue, supply a factory that returns the Vue Component (NOT a render<br/>call), e.g. `({ adaptableApi }) => MyMenuItem`. AG Grid Vue then<br/>instantiates the component using its own framework adapter and passes<br/>`name`, `icon`, `menuItemParams`, ... as props.<br/><br/>For Angular, supply `{ type: MyMenuItemComponent }` where the component<br/>implements `IMenuItemAngularComp` (with `agInit(params)` to receive<br/>`params.menuItemParams.adaptableApi` and `params.menuItemParams.menuContext`).<br/>The `onSetup` callback on `AngularFrameworkComponent` is NOT honoured<br/>for menu items because AG Grid owns the component lifecycle. |
| [hidden](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#hidden) | `boolean` | Whether menu item is hidden |
| [icon](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#icon) | [`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md) | Optional icon to display |
| [label](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#label) | `string` | Text to appear in the Menu Item |
| [menuItemParams](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#menuitemparams) | `Record<string, unknown>` | Extra parameters passed through to the Framework Component (alongside<br/>`adaptableApi` and `menuContext`). |
| [menuType](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#menutype) | `'User'` | Type of Menu - always &#39;User&#39; |
| [onClick](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#onclick) | `(menuContext: `[`ColumnMenuContext`](https://www.adaptabletools.com/docs/reference/columnmenucontext.md)`) => void` | Function invoked when the Menu Item is clicked |
| [subMenuItems](https://www.adaptabletools.com/docs/reference/usercolumnmenuitem.md#submenuitems) | [`CustomColumnMenuItem`](https://www.adaptabletools.com/docs/reference/customcolumnmenuitem.md)`[]` | Array of Menu Items, enabling limitless levels of menus |

## Property Details

### disabled

Whether menu item is disabled

```ts title="TypeScript"
disabled?: boolean;
```

###### Property Value

`boolean`

### frameworkComponent

Optional Framework Component (React, Angular or Vue) used to render the
content of this menu item.

When supplied, AG Grid renders the component inside the menu row using
its own framework adapter. The component receives AG Grid&#39;s
`CustomMenuItemProps`, with the AdapTable-specific extras
(`adaptableApi`, `menuContext`, plus anything passed via
`menuItemParams`) available as `props.menuItemParams`.

Supported in the React, Vue and Angular variants of AdapTable.

For Vue, supply a factory that returns the Vue Component (NOT a render
call), e.g. `({ adaptableApi }) => MyMenuItem`. AG Grid Vue then
instantiates the component using its own framework adapter and passes
`name`, `icon`, `menuItemParams`, ... as props.

For Angular, supply `{ type: MyMenuItemComponent }` where the component
implements `IMenuItemAngularComp` (with `agInit(params)` to receive
`params.menuItemParams.adaptableApi` and `params.menuItemParams.menuContext`).
The `onSetup` callback on `AngularFrameworkComponent` is NOT honoured
for menu items because AG Grid owns the component lifecycle.

```ts title="TypeScript"
frameworkComponent?: MenuItemFrameworkComponent<ColumnMenuContext>;
```

###### Property Value

[`MenuItemFrameworkComponent`](https://www.adaptabletools.com/docs/reference/menuitemframeworkcomponent.md)`<`[`ColumnMenuContext`](https://www.adaptabletools.com/docs/reference/columnmenucontext.md)`>`

### hidden

Whether menu item is hidden

```ts title="TypeScript"
hidden?: boolean;
```

###### Property Value

`boolean`

### icon

Optional icon to display

```ts title="TypeScript"
icon?: AdaptableIcon;
```

###### Property Value

[`AdaptableIcon`](https://www.adaptabletools.com/docs/reference/adaptableicon.md)

### label

Text to appear in the Menu Item

```ts title="TypeScript"
label: string;
```

###### Property Value

`string`

### menuItemParams

Extra parameters passed through to the Framework Component (alongside
`adaptableApi` and `menuContext`).

```ts title="TypeScript"
menuItemParams?: Record<string, unknown>;
```

###### Property Value

`Record<string, unknown>`

### menuType

Type of Menu - always &#39;User&#39;

```ts title="TypeScript"
menuType: 'User';
```

###### Property Value

`'User'`

### onClick

Function invoked when the Menu Item is clicked

```ts title="TypeScript"
onClick?: (menuContext: ColumnMenuContext) => void;
```

###### Property Value

`(menuContext: `[`ColumnMenuContext`](https://www.adaptabletools.com/docs/reference/columnmenucontext.md)`) => void`

### subMenuItems

Array of Menu Items, enabling limitless levels of menus

```ts title="TypeScript"
subMenuItems?: CustomColumnMenuItem[];
```

###### Property Value

[`CustomColumnMenuItem`](https://www.adaptabletools.com/docs/reference/customcolumnmenuitem.md)`[]`
