@mantine/core
Version:
React components library focused on usability, accessibility and developer experience
36 lines (35 loc) • 1.36 kB
TypeScript
import { BoxProps, ElementProps, Factory, StylesApiProps } from '../../core';
import { PortalProps } from '../Portal';
export type AffixStylesNames = 'root';
export type AffixCssVariables = {
root: '--affix-z-index' | '--affix-top' | '--affix-left' | '--affix-bottom' | '--affix-right';
};
export interface AffixBaseProps {
/** Root element `z-index` property, `200` by default */
zIndex?: string | number;
/** Determines whether component should be rendered within portal, `true` by default */
withinPortal?: boolean;
/** Props to pass down to the `Portal` component when `withinPortal` is set */
portalProps?: Omit<PortalProps, 'children'>;
/** Affix position on screen, defaults value is `{ bottom: 0, right: 0 }` */
position?: {
top?: string | number;
left?: string | number;
bottom?: string | number;
right?: string | number;
};
}
export interface AffixProps extends BoxProps, AffixBaseProps, StylesApiProps<AffixFactory>, ElementProps<'div'> {
}
export type AffixFactory = Factory<{
props: AffixProps;
ref: HTMLDivElement;
stylesNames: AffixStylesNames;
vars: AffixCssVariables;
}>;
export declare const Affix: import("../../core").MantineComponent<{
props: AffixProps;
ref: HTMLDivElement;
stylesNames: AffixStylesNames;
vars: AffixCssVariables;
}>;