@mskcc/carbon-react
Version:
Carbon react components for the MSKCC DSM
36 lines (35 loc) • 861 B
TypeScript
/**
* MSKCC DSM 2021, 2023
*/
import * as React from 'react';
export type GridMode = 'flexbox' | 'css-grid';
export interface GridSettingContext {
/**
* The grid mode for the GridContext
*/
mode: GridMode;
/**
* Specifies whether subgrid should be enabled
*/
subgrid?: boolean;
}
export interface GridSettingsProps {
/**
* Pass in components which will be rendered within the `GridSettings`
* component
*/
children?: React.ReactNode;
/**
* Specify the grid mode for the GridContext
*/
mode: GridMode;
/**
* Specify whether subgrid should be enabled
*/
subgrid?: boolean;
}
export declare const GridSettings: React.FC<GridSettingsProps>;
/**
* Helper function for accessing the GridContext value
*/
export declare const useGridSettings: () => GridSettingContext;