Options
All
  • Public
  • Public/Protected
  • All
Menu

fine-mq

Index

Type aliases

Functions

Object literals

Type aliases

FineMediaQueries

FineMediaQueries: { addAlias: (alias: string | {}, mediaQuery?: MediaQueryToMatch | QueryObject) => void; mq: Mq; off: (aliasOrMediaQuery?: undefined | string, callback?: MediaQueryMatcherHandler) => void; on: (aliasOrMediaQuery: string, callback: MediaQueryMatcherHandler) => void; removeAlias: (alias: string) => void; setMatchingAliases: (matchingAliases: MatchingAliases) => void }

Type declaration

MatchingAliases

MatchingAliases: {}

Type declaration

  • [alias: string]: boolean

MediaQueryAliases

MediaQueryAliases: {}

Type declaration

MediaQueryMatchListener

MediaQueryMatchListener: { handlers: MediaQueryMatcherHandler[]; listener: (e: MediaQueryListEvent | { matches: boolean }) => void; matcher: MediaQueryList }

Type declaration

  • Readonly handlers: MediaQueryMatcherHandler[]
  • Readonly listener: (e: MediaQueryListEvent | { matches: boolean }) => void
      • (e: MediaQueryListEvent | { matches: boolean }): void

      • Parameters

        • e: MediaQueryListEvent | { matches: boolean }

        Returns void

  • Readonly matcher: MediaQueryList

MediaQueryMatcherHandler

MediaQueryMatcherHandler: (matchedMq: MediaQueryMatcherHandlerParams) => void

Type declaration

MediaQueryMatcherHandlerParams

MediaQueryMatcherHandlerParams: { alias: string; matches: boolean; mediaQuery: MediaQueryToMatch }

Type declaration

  • Readonly alias: string
  • Readonly matches: boolean
  • Readonly mediaQuery: MediaQueryToMatch

MediaQueryMatchers

MediaQueryMatchers: {}

Type declaration

MediaQueryObject

MediaQueryObject: string | number | [number, undefined | number] | MediaQueryToMatch | QueryObject

MediaQueryObjectWithShortcuts

MediaQueryObjectWithShortcuts: MediaQueryObject | number | [number, undefined | number]

MediaQueryToMatch

MediaQueryToMatch: string

Mq

Mq: { aliases: MediaQueryAliases; matchers: MediaQueryMatchers; matchingAliases: MatchingAliases }

Type declaration

MqDimensionBoundaries

MqDimensionBoundaries: { bounds: [any, any]; boundsParsed: [any, any] }

Type declaration

  • bounds: [any, any]
  • boundsParsed: [any, any]

Functions

Const addAlias

Const aliases2mq

Const createFineMediaQueries

Const createMediaQueryMatchListener

Const expandAliases

  • expandAliases(aliases: {}): {}

Const getAliasModifiers

  • getAliasModifiers(alias: string, __namedParameters: { bounds: [undefined, any]; boundsParsed: [any, any] }): {}

  • Parameters

    • alias: string
    • __namedParameters: { bounds: [undefined, any]; boundsParsed: [any, any] }
      • bounds: [undefined, any]
      • boundsParsed: [any, any]

    Returns {}

    • [key: string]: any

Const getAliasesForMediaQuery

  • getAliasesForMediaQuery(mq: Mq, mediaQuery: string): string[]

Const getDimensionBounds

  • getDimensionBounds(dimension: any): [any, any]

Const getMatchListener

Const getMediaQueryString

Const getUnshortenedMqObject

  • getUnshortenedMqObject(__namedParameters: { boundsParsed: [any, any] }): MediaQueryObject

Const isDimension

  • isDimension(v: any): boolean

Const isUnitValue

  • isUnitValue(v: any): boolean

Const json2mq

Const off

Const on

Const parseToPxOrKeepValue

  • parseToPxOrKeepValue(v: any): any

Const removeAlias

  • removeAlias(mq: Mq, alias: string): void

Const removeMediaQueryMatchListener

  • removeMediaQueryMatchListener(mq: Mq, aliasOrMediaQuery: string): void

Const setMatchingAliases

Const unshortenAliasMq

Object literals

Const FineMqPlugin

FineMqPlugin: object

install

Generated using TypeDoc