[O3 Framework](../API.md) / SetLeftNavParams

# Interface: SetLeftNavParams

Defined in: [packages/framework/esm-extensions/src/left-nav.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L22)

## Properties

### basePath

> **basePath**: `string`

Defined in: [packages/framework/esm-extensions/src/left-nav.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L24)

***

### componentContext?

> `optional` **componentContext**: [`ComponentConfig`](ComponentConfig.md)

Defined in: [packages/framework/esm-extensions/src/left-nav.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L31)

***

### mode?

> `optional` **mode**: `LeftNavMode`

Defined in: [packages/framework/esm-extensions/src/left-nav.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L30)

In normal mode, the left nav is shown in desktop mode, and collapse into hamburger menu button in tablet mode
In collapsed mode, the left nav is always collapsed, regardless of desktop / tablet mode.
In hidden mode, the left nav is not shown at all.

***

### name

> **name**: `string`

Defined in: [packages/framework/esm-extensions/src/left-nav.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L23)

***

### state?

> `optional` **state**: [`ExtensionSlotState`](ExtensionSlotState.md)

Defined in: [packages/framework/esm-extensions/src/left-nav.ts:32](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-extensions/src/left-nav.ts#L32)