@devseed-ui/theme-provider/src/helpers.d.ts

devseed UI Kit Theme

import { FlattenSimpleInterpolation } from "styled-components";

declare module '@devseed-ui/theme-provider' {
  /**
   * Applies anti-aliasing to font rendering, making the text more readable and
   * pleasing to the eye. Webkit and mozilla specific.
   */
  function antialiased(): FlattenSimpleInterpolation;

  /**
   * Hides elements visually, but preserving its accessibility to screen readers
   * or crawlers. Useful for semantic solutions.
   */
  function visuallyHidden(): FlattenSimpleInterpolation;

  /**
   * Removes default list (`ul` and `ol`) styling. Say goodbye to default
   * padding, margin, and bullets/numbers.
   */
  function listReset(): FlattenSimpleInterpolation;

  /**
   * Truncates a text string and applies ellipsis. Requires a declared width
   * value.
   */
  function truncated(): FlattenSimpleInterpolation;

  /**
   * Applies disabled styles to an element, and disabled pointer events.
   */
  function visuallyDisabled(): FlattenSimpleInterpolation;

  /**
   * The same behavior as `disabled`, but the pointer events remain active. This
   * is useful when, for example, paired with a tooltip that needs the `hover`
   * event to fire.
   */
  function disabled(): FlattenSimpleInterpolation;

  /**
   * Constrains element content to its declared height, preventing vertical
   * scrolling.
   */
  function unscrollableY(): FlattenSimpleInterpolation;

  /**
   * Constrains element content to its declared width, preventing horizontal
   * scrolling.
   */
  function unscrollableX(): FlattenSimpleInterpolation;
}