@massds/mayflower-react
Version:
React versions of Mayflower design system UI components
48 lines (47 loc) • 1.36 kB
TypeScript
/**
* TeaserListing module.
* @module @massds/mayflower-react/TeaserListing
* @requires module:@massds/mayflower-assets/scss/03-organisms/teaser-listing
*/
import React from 'react';
export interface TeaserListingProps {
/** React children to render */
children: React.ReactNode;
}
/**
List wrapper
*/
declare const TeaserListing: {
({ children }: TeaserListingProps): any;
displayName: string;
Features: {
({ children, stacked }: TeaserListingFeaturesProps): any;
defaultProps: {
stacked: boolean;
};
};
Items: {
({ columns, children }: TeaserListingItemsProps): any;
defaultProps: {
columns: number;
};
};
Item: ({ children }: TeaserListingItemProps) => any;
};
export default TeaserListing;
export interface TeaserListingFeaturesProps {
/** Stacked if true, side-by-side if false. */
stacked?: boolean;
/** React children to render */
children: React.ReactNode;
}
export interface TeaserListingItemsProps {
/** Set for two column or three column layout for large screens. (Both display the same at smaller screen widths) */
columns?: 2 | 3;
/** React children to render */
children: React.ReactNode;
}
export interface TeaserListingItemProps {
/** React children to render */
children: React.ReactNode;
}