@atlaskit/focused-task-close-account
Version:
This package contains all of the UI components needed to assemble the focused tasks for deactivating and deleting users' accounts in accordance with the GDPR "Right to be forgotten".
186 lines (161 loc) • 4.46 kB
Markdown
<!-- API Report Version: 2.3 -->
## API Report File for "@atlaskit/focused-task-close-account"
> 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)
### Table of contents
- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)
### Main Entry Types
<!--SECTION START: Main Entry Types-->
```ts
import { MessageDescriptor } from 'react-intl-next';
import { default as React_2 } from 'react';
// @public (undocumented)
export class DeactivateUserOverviewScreen extends React_2.Component<DeactivateUserOverviewScreenProps> {
// (undocumented)
static defaultProps: Partial<DeactivateUserOverviewScreenProps>;
// (undocumented)
render(): JSX.Element;
// (undocumented)
renderBillingListElement: () => JSX.Element;
// (undocumented)
renderLoseAccessListElement: () => JSX.Element;
// (undocumented)
renderPersonalDataListElement: () => JSX.Element;
// (undocumented)
selectAdminOrSelfCopy: (
adminCopy: MessageDescriptor,
selfCopy: MessageDescriptor,
) => MessageDescriptor;
}
// @public (undocumented)
interface DeactivateUserOverviewScreenProps {
// (undocumented)
accessibleSites: string[];
// (undocumented)
isCurrentUser: boolean;
// (undocumented)
user: User;
}
// @public (undocumented)
export class DeleteUserContentPreviewScreen extends React_2.Component<
DeleteUserContentPreviewScreenProps,
DeleteUserContentPreviewScreenState
> {
// (undocumented)
componentDidMount(): void;
// (undocumented)
handleClickSection: (userName: string, position: number) => () => void;
// (undocumented)
isCardSelected: (position: number) => boolean;
// (undocumented)
render(): JSX.Element;
// (undocumented)
selectAdminOrSelfCopy: (
adminCopy: MessageDescriptor,
selfCopy: MessageDescriptor,
) => MessageDescriptor;
// (undocumented)
state: DeleteUserContentPreviewScreenState;
}
// @public (undocumented)
interface DeleteUserContentPreviewScreenProps {
// (undocumented)
isCurrentUser: boolean;
// (undocumented)
preferenceSelection: (username: string) => void;
// (undocumented)
user: User;
}
// @public (undocumented)
interface DeleteUserContentPreviewScreenState {
// (undocumented)
currentActive: number;
}
// @public (undocumented)
export class DeleteUserOverviewScreen extends React_2.Component<DeleteUserOverviewScreenProps> {
// (undocumented)
static defaultProps: Partial<DeleteUserOverviewScreenProps>;
// (undocumented)
displayFirstListElement: () => JSX.Element | null;
// (undocumented)
displayFourthListElement: () => JSX.Element;
// (undocumented)
displaySecondListElement: () => JSX.Element;
// (undocumented)
displayThirdListElement: () => JSX.Element;
// (undocumented)
render(): JSX.Element;
// (undocumented)
selectAdminOrSelfCopy: (
adminCopy: MessageDescriptor,
selfCopy: MessageDescriptor,
) => MessageDescriptor;
}
// @public (undocumented)
interface DeleteUserOverviewScreenProps {
// (undocumented)
accessibleSites: string[];
// (undocumented)
deactivateUserHandler?: () => void;
// (undocumented)
isCurrentUser: boolean;
// (undocumented)
isUserDeactivated: boolean;
// (undocumented)
user: User;
}
// @public (undocumented)
export class FocusedTaskCloseAccount extends React_2.Component<Props, State> {
// (undocumented)
nextScreen: () => void;
// (undocumented)
previousScreen: () => void;
// (undocumented)
render(): JSX.Element;
// (undocumented)
renderCurrentScreen: () => React_2.ReactNode;
// (undocumented)
state: State;
}
// @public (undocumented)
interface Props {
// (undocumented)
isOpen: boolean;
// (undocumented)
learnMoreLink: string;
// (undocumented)
onClose: () => void;
// (undocumented)
screens: React_2.ReactNode[];
// (undocumented)
submitButton: React_2.ReactNode;
}
// @public (undocumented)
interface State {
// (undocumented)
currentScreenIdx: number;
}
// @public (undocumented)
interface User {
// (undocumented)
avatarUrl: string;
// (undocumented)
email: string;
// (undocumented)
fullName: string;
}
// (No @packageDocumentation comment for this package)
```
<!--SECTION END: Main Entry Types-->
### Peer Dependencies
<!--SECTION START: Peer Dependencies-->
```json
{
"react": "^16.8.0",
"react-dom": "^16.8.0",
"react-transition-group": "^4.4.1"
}
```
<!--SECTION END: Peer Dependencies-->