@awsui/components-react
Version:
On July 19th, 2022, we launched [Cloudscape Design System](https://cloudscape.design). Cloudscape is an evolution of AWS-UI. It consists of user interface guidelines, front-end components, design resources, and development tools for building intuitive, en
40 lines • 1.59 kB
TypeScript
/// <reference types="react" />
import { BaseComponentProps } from '../internal/base-component';
import { StatusIndicatorProps } from '../status-indicator/internal';
export interface StepsProps extends BaseComponentProps {
/**
* An array of individual steps
*
* Each step definition has the following properties:
* * `status` (string) - Status of the step corresponding to a status indicator.
* * `statusIconAriaLabel` - (string) - (Optional) Alternative text for the status icon.
* * `header` (ReactNode) - Summary corresponding to the step.
* * `details` (ReactNode) - (Optional) Additional information corresponding to the step.
*/
steps: ReadonlyArray<StepsProps.Step>;
/**
* Provides an `aria-label` to the progress steps container.
* Don't use `ariaLabel` and `ariaLabelledby` at the same time.
*/
ariaLabel?: string;
/**
* Sets the `aria-labelledby` property on the progress steps container.
* If there's a visible label element that you can reference, use this instead of `ariaLabel`.
* Don't use `ariaLabel` and `ariaLabelledby` at the same time.
*/
ariaLabelledby?: string;
/**
* Sets the `aria-describedby` property on the progress steps container.
*/
ariaDescribedby?: string;
}
export declare namespace StepsProps {
type Status = StatusIndicatorProps.Type;
interface Step {
status: Status;
statusIconAriaLabel?: string;
header: React.ReactNode;
details?: React.ReactNode;
}
}
//# sourceMappingURL=interfaces.d.ts.map