@types/gatsby-plugin-breakpoints v1.3.5

Installation

npm install --save @types/gatsby-plugin-breakpoints

Summary

This package contains type definitions for gatsby-plugin-breakpoints (https://github.com/JimmyBeldone/gatsby-plugin-breakpoints).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gatsby-plugin-breakpoints.

index.d.ts

// Type definitions for gatsby-plugin-breakpoints 1.3
// Project: https://github.com/JimmyBeldone/gatsby-plugin-breakpoints
// Definitions by: Iva Kop <https://github.com/IvaKop>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/**
 * @see https://www.gatsbyjs.com/plugins/gatsby-plugin-breakpoints/
 */

export type BreakpointsObject = Record<string, boolean>;

export type QueriesObject = Record<string, string>;
export interface BreakpointProps {
    breakpoints: BreakpointsObject;
}

export interface BreakpointProviderProps {
    children: React.ReactNode;
    queries: QueriesObject;
}

export interface BreakpointOptions {
    queries?: QueriesObject | undefined;
}
export interface BreakpointConfig {
    resolve: 'gatsby-plugin-breakpoints';
    options?: BreakpointOptions | undefined;
}

export function useBreakpoint(): BreakpointsObject;

export function withBreakpoints<P extends BreakpointProps>(Component: React.ComponentType<P>): React.ComponentType<P>;

export const BreakpointContext: React.Context<QueriesObject>;

export const BreakpointProvider: React.ProviderExoticComponent<BreakpointProviderProps>;

Additional Details

• Last updated: Thu, 08 Jul 2021 12:02:00 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by Iva Kop.