@polgubau/utils
Version:
A collection of utility functions for TypeScript
23 lines (21 loc) • 747 B
text/typescript
/**
* @name DirEnum
* @description Enum for the different directions, rtl, ltr and auto
* @property {string} rtl - Right to left direction
* @property {string} ltr - Left to right direction
* @property {string} auto - Automatic direction
* @example
* <Tooltip dir={DirEnum.rtl} ... // Right to left direction
* <Tooltip dir={DirEnum.ltr} ... // Left to right direction
* <Tooltip dir={DirEnum.auto} ... // Automatic direction
* @see getDocumentDirection for the usage of this enum
* @author Pol Gubau Amores - https://polgubau.com
*/
declare enum DirEnum {
rtl = "rtl",
ltr = "ltr",
auto = "auto"
}
type Dir = `${DirEnum}`;
declare function getDocumentDirection(): Dir;
export { type Dir, DirEnum, getDocumentDirection };