@adaptabletools/adaptable
Version:
Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
34 lines (33 loc) • 1.58 kB
TypeScript
import * as React from 'react';
import { AdaptableApi } from '../../../Api/AdaptableApi';
import { BadgePillStyle } from '../../../AdaptableState/StyledColumns/BadgeStyle';
export interface BadgePillStyleEditorProps {
api: AdaptableApi;
/** Current pill style (may be undefined / partial). */
value: BadgePillStyle | undefined;
/**
* Called whenever the pill style changes. Pass `undefined` to clear the
* pill style entirely (every key unset).
*/
onChange: (next: BadgePillStyle | undefined) => void;
disabled?: boolean;
/** When true, omit outer border — for use inside a wizard Card body. */
embedded?: boolean;
}
/**
* Compact editor for the cut-down {@link BadgePillStyle}.
*
* Intentionally narrower than `StyleComponent`:
* - **No** `BorderRadius` — corner radius is owned by `Shape`.
* - **No** `Alignment` — badge-row alignment is column-level (`BadgeStyle.Font`).
* - **No** `ClassName` — pill `ClassName` had no effect at runtime; gone.
* - **No** `FontSize` — pills inherit cell font sizing.
*/
export declare const BadgePillStyleEditor: React.FunctionComponent<BadgePillStyleEditorProps>;
/** Descriptive pill properties for summary panels (`Label: value` strings). */
export declare const getBadgePillStyleSummaryItems: (pill: BadgePillStyle | undefined) => {
label: string;
value: string;
}[];
/** Compact summary tags for a {@link BadgePillStyle}; used by wizard summaries. */
export declare const renderBadgePillStyleSummaryTags: (pill: BadgePillStyle | undefined) => React.JSX.Element | null;