@empathyco/x-components
Version:
Empathy X Components
81 lines (75 loc) • 2.51 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [PageSelector](./x-components.pageselector.md)
## PageSelector variable
Component that renders a pagination control with buttons for navigating between pages. It displays the current page, allows selecting other pages, and emits events when a page is selected.
**Signature:**
```typescript
_default: import("vue").DefineComponent<{
buttonClasses: {
type: PropType<(string | Dictionary<boolean>)[]>;
default: () => never[];
};
currentPage: {
type: NumberConstructor;
required: true;
};
hiddenPage: {
type: StringConstructor;
default: string;
};
itemClasses: {
type: PropType<(isSelected: boolean) => string | Dictionary<boolean> | (string | Dictionary<boolean>)[]>;
default: () => never[];
};
range: {
type: NumberConstructor;
default: number;
};
scrollTarget: {
type: StringConstructor;
default: string;
};
totalPages: {
type: NumberConstructor;
required: true;
};
}, {
visiblePages: import("vue").ComputedRef<PageItem[]>;
selectPage: (page: number | string) => void;
}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
buttonClasses: {
type: PropType<(string | Dictionary<boolean>)[]>;
default: () => never[];
};
currentPage: {
type: NumberConstructor;
required: true;
};
hiddenPage: {
type: StringConstructor;
default: string;
};
itemClasses: {
type: PropType<(isSelected: boolean) => string | Dictionary<boolean> | (string | Dictionary<boolean>)[]>;
default: () => never[];
};
range: {
type: NumberConstructor;
default: number;
};
scrollTarget: {
type: StringConstructor;
default: string;
};
totalPages: {
type: NumberConstructor;
required: true;
};
}>>, {
buttonClasses: (string | Dictionary<boolean>)[];
hiddenPage: string;
itemClasses: (isSelected: boolean) => string | Dictionary<boolean> | (string | Dictionary<boolean>)[];
range: number;
scrollTarget: string;
}, {}>
```