@empathyco/x-components
Version:
Empathy X Components
51 lines (43 loc) • 1.98 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [/x-components](./x-components.md) > [BaseIdTogglePanel](./x-components.baseidtogglepanel.md)
## BaseIdTogglePanel variable
Simple panel that could receives its initial open state via prop, if not the default is opens and a required prop, named `panelId`<!-- -->, which are responsible of rendering default slot inside a configurable transition.
It reacts to `UserClickedPanelToggleButton` event, when their payload matches the component's 'panelId' prop, to handle its open/close state.
The default slot offers the possibility to customise the modal content.
**Signature:**
```typescript
_default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
startOpen: {
type: BooleanConstructor;
default: boolean;
};
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: () => import("vue").DefineComponent<{}, {}, any>;
};
panelId: {
type: StringConstructor;
required: true;
};
}>, {
isOpen: import("vue").Ref<boolean, boolean>;
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
startOpen: {
type: BooleanConstructor;
default: boolean;
};
animation: {
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
default: () => import("vue").DefineComponent<{}, {}, any>;
};
panelId: {
type: StringConstructor;
required: true;
};
}>> & Readonly<{}>, {
startOpen: boolean;
animation: string | Function | Record<string, any>;
}, {}, {
BaseTogglePanel: import("vue").DefineComponent<{}, {}, any>;
}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
```