@atlaskit/status
Version:
Fabric Status React Components
105 lines (82 loc) • 2.55 kB
Markdown
<!-- API Report Version: 2.3 -->
> Do not edit this file. This report is auto-generated using
> [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
- [Main Entry Types](
- [Peer Dependencies](
<!--SECTION START: Main Entry Types-->
```ts
/// <reference types="react" />
import { ForwardRefExoticComponent } from 'react';
import { default as React_2 } from 'react';
import { RefAttributes } from 'react';
import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
import { WithIntlProps } from 'react-intl-next';
import { WrappedComponentProps } from 'react-intl-next';
// @public (undocumented)
export type Color = 'blue' | 'green' | 'neutral' | 'purple' | 'red' | 'yellow';
// @public (undocumented)
type ColorType = Color;
// @public (undocumented)
interface OwnProps {
// (undocumented)
color: Color;
// (undocumented)
localId?: string;
// (undocumented)
onClick?: (event: React.SyntheticEvent<any>) => void;
// (undocumented)
onHover?: () => void;
// (undocumented)
role?: string;
// (undocumented)
style?: StatusStyle;
// (undocumented)
text: string;
}
// @public (undocumented)
export type Props = OwnProps & WithAnalyticsEventsProps;
// @public (undocumented)
export const Status: ForwardRefExoticComponent<
Omit<Props, keyof WithAnalyticsEventsProps> & RefAttributes<any>
>;
// @public (undocumented)
export const StatusPicker: React_2.FC<
WithIntlProps<StatusPickerProps & WrappedComponentProps<'intl'>>
> & {
WrappedComponent: React_2.ComponentType<StatusPickerProps & WrappedComponentProps<'intl'>>;
};
// @public (undocumented)
export interface StatusPickerProps {
// (undocumented)
autoFocus?: boolean;
// (undocumented)
onColorClick: (value: ColorType) => void;
// (undocumented)
onColorHover?: (value: ColorType) => void;
// (undocumented)
onEnter: () => void;
// (undocumented)
onTextChanged: (value: string) => void;
// (undocumented)
selectedColor: ColorType;
// (undocumented)
text: string;
}
// @public (undocumented)
export type StatusStyle = 'bold' | 'subtle';
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0",
"react-intl-next": "npm:react-intl@^5.18.1"
}
```
<!--SECTION END: Peer Dependencies-->