aws-northstar/layouts/ColumnLayout/index.d.ts

NorthStar Design System

/** *******************************************************************************************************************
  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  
  Licensed under the Apache License, Version 2.0 (the "License").
  You may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
      http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.                                                                              *
 ******************************************************************************************************************** */
import { ReactElement, FunctionComponent } from 'react';
import Column, { ColumnProps as _ColumnProps } from './components/Column';
export declare type ColumnProps = _ColumnProps;
declare type BreakPoint = 'xs' | 'sm' | 'md' | 'lg';
export interface ColumnLayoutProps {
    /** Indicate whether to render divider between columns*/
    renderDivider?: boolean;
    /** A list of column elements*/
    children: Array<ReactElement<ColumnProps> | null> | ReactElement<ColumnProps> | null;
    /** Collapse the columns below certain breakpoint. <br/>
     * Available options: 'xs' | 'sm' | 'md' | 'lg'. <br/>
     * The columns always collapse at xs and are alawys displayed as column layout at xl*/
    collapseBelow?: BreakPoint;
}
/**
 * The column layout is a helper component to ease the layout process.
 * Within containers, users can position their content in typical layouts, for example: two columns in a row.
 */
declare const ColumnLayout: FunctionComponent<ColumnLayoutProps>;
export default ColumnLayout;
export { Column };