@atlaskit/help-layout 4.2.2 → 4.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/version.json +1 -1
  3. package/dist/es2019/version.json +1 -1
  4. package/dist/esm/version.json +1 -1
  5. package/dist/types-ts4.5/analytics.d.ts +10 -0
  6. package/dist/types-ts4.5/components/Header/BackButton.d.ts +12 -0
  7. package/dist/types-ts4.5/components/Header/CloseButton.d.ts +17 -0
  8. package/dist/types-ts4.5/components/Header/index.d.ts +8 -0
  9. package/dist/types-ts4.5/components/Header/styled.d.ts +6 -0
  10. package/dist/types-ts4.5/components/HelpLayout.d.ts +9 -0
  11. package/dist/types-ts4.5/components/HelpLayoutContent.d.ts +8 -0
  12. package/dist/types-ts4.5/components/MessagesIntlProvider.d.ts +11 -0
  13. package/dist/types-ts4.5/components/constants.d.ts +8 -0
  14. package/dist/types-ts4.5/components/styled.d.ts +17 -0
  15. package/dist/types-ts4.5/i18n/cs.d.ts +2 -0
  16. package/dist/types-ts4.5/i18n/da.d.ts +2 -0
  17. package/dist/types-ts4.5/i18n/de.d.ts +2 -0
  18. package/dist/types-ts4.5/i18n/en.d.ts +2 -0
  19. package/dist/types-ts4.5/i18n/en_GB.d.ts +2 -0
  20. package/dist/types-ts4.5/i18n/es.d.ts +4 -0
  21. package/dist/types-ts4.5/i18n/et.d.ts +2 -0
  22. package/dist/types-ts4.5/i18n/fi.d.ts +2 -0
  23. package/dist/types-ts4.5/i18n/fr.d.ts +2 -0
  24. package/dist/types-ts4.5/i18n/hu.d.ts +2 -0
  25. package/dist/types-ts4.5/i18n/index.d.ts +24 -0
  26. package/dist/types-ts4.5/i18n/is.d.ts +2 -0
  27. package/dist/types-ts4.5/i18n/it.d.ts +2 -0
  28. package/dist/types-ts4.5/i18n/ja.d.ts +2 -0
  29. package/dist/types-ts4.5/i18n/ko.d.ts +2 -0
  30. package/dist/types-ts4.5/i18n/languages.d.ts +27 -0
  31. package/dist/types-ts4.5/i18n/nb.d.ts +2 -0
  32. package/dist/types-ts4.5/i18n/nl.d.ts +2 -0
  33. package/dist/types-ts4.5/i18n/pl.d.ts +2 -0
  34. package/dist/types-ts4.5/i18n/pt_BR.d.ts +2 -0
  35. package/dist/types-ts4.5/i18n/pt_PT.d.ts +2 -0
  36. package/dist/types-ts4.5/i18n/ro.d.ts +2 -0
  37. package/dist/types-ts4.5/i18n/ru.d.ts +2 -0
  38. package/dist/types-ts4.5/i18n/sk.d.ts +2 -0
  39. package/dist/types-ts4.5/i18n/sv.d.ts +2 -0
  40. package/dist/types-ts4.5/i18n/zh.d.ts +2 -0
  41. package/dist/types-ts4.5/index.d.ts +1 -0
  42. package/dist/types-ts4.5/messages.d.ts +22 -0
  43. package/dist/types-ts4.5/model/HelpLayout.d.ts +14 -0
  44. package/dist/types-ts4.5/util/i18n-util.d.ts +17 -0
  45. package/package.json +2 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/help-layout
2
2
 
3
+ ## 4.2.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`61cb5313358`](https://bitbucket.org/atlassian/atlassian-frontend/commits/61cb5313358) - Removing unused dependencies and dev dependencies
8
+
9
+ ## 4.2.3
10
+
11
+ ### Patch Changes
12
+
13
+ - [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
14
+
3
15
  ## 4.2.2
4
16
 
5
17
  ### Patch Changes
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-layout",
3
- "version": "4.2.2",
3
+ "version": "4.2.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-layout",
3
- "version": "4.2.2",
3
+ "version": "4.2.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help-layout",
3
- "version": "4.2.2",
3
+ "version": "4.2.4",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1,10 @@
1
+ /// <reference types="react" />
2
+ import * as x from '@atlaskit/analytics-next';
3
+ export declare const withAnalyticsEvents: (createEventMap?: import("@atlaskit/analytics-next/types").CreateEventMap | undefined) => <Props extends x.WithAnalyticsEventsProps, Component>(WrappedComponent: import("react").JSXElementConstructor<Props> & Component) => import("react").ForwardRefExoticComponent<import("react").PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Omit<Props, keyof x.WithAnalyticsEventsProps>>> & import("react").RefAttributes<any>>;
4
+ export declare const withAnalyticsContext: (defaultData?: any) => <Props, Component>(WrappedComponent: import("react").JSXElementConstructor<Props> & Component) => import("react").ForwardRefExoticComponent<import("react").PropsWithoutRef<JSX.LibraryManagedAttributes<Component, Props & x.WithContextProps>> & import("react").RefAttributes<any>>;
5
+ export declare const createAndFire: (payload: x.AnalyticsEventPayload) => (createAnalyticsEvent: x.CreateUIAnalyticsEvent) => x.UIAnalyticsEvent;
6
+ export declare const defaultAnalyticsAttributes: {
7
+ componentName: string;
8
+ packageName: any;
9
+ packageVersion: any;
10
+ };
@@ -0,0 +1,12 @@
1
+ import React from 'react';
2
+ import { WrappedComponentProps } from 'react-intl-next';
3
+ import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
4
+ interface Props {
5
+ onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
6
+ isVisible?: boolean;
7
+ }
8
+ export declare const BackButton: React.FC<Props & WrappedComponentProps>;
9
+ declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
10
+ WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
11
+ };
12
+ export default _default;
@@ -0,0 +1,17 @@
1
+ import React from 'react';
2
+ import { WrappedComponentProps } from 'react-intl-next';
3
+ import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
4
+ interface Props {
5
+ onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
6
+ }
7
+ /**
8
+ * This function will return a CloseButton component only if the function
9
+ * to be executed on the onClick event is passed as a parameter
10
+ *
11
+ * @param onClick - Function executed when the close btn is clicked
12
+ */
13
+ export declare const CloseButton: React.FC<Props & WrappedComponentProps>;
14
+ declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
15
+ WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
16
+ };
17
+ export default _default;
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ import { WrappedComponentProps } from 'react-intl-next';
3
+ import { HelpPanelHeader } from '../../model/HelpLayout';
4
+ export declare const HelpContent: React.FC<HelpPanelHeader & WrappedComponentProps>;
5
+ declare const _default: React.FC<import("react-intl-next").WithIntlProps<HelpPanelHeader & WrappedComponentProps<"intl">>> & {
6
+ WrappedComponent: React.ComponentType<HelpPanelHeader & WrappedComponentProps<"intl">>;
7
+ };
8
+ export default _default;
@@ -0,0 +1,6 @@
1
+ /// <reference types="react" />
2
+ export declare const HeaderContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
3
+ export declare const CloseButtonContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
4
+ export declare const BackButtonContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
5
+ export declare const HeaderTitle: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
6
+ export declare const HeaderContent: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
@@ -0,0 +1,9 @@
1
+ import React from 'react';
2
+ import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
3
+ import { HelpLayout as HelpLayoutProps } from '../model/HelpLayout';
4
+ export type Props = HelpLayoutProps & WithAnalyticsEventsProps;
5
+ export declare class HelpLayout extends React.PureComponent<Props> {
6
+ render(): JSX.Element;
7
+ }
8
+ declare const _default: React.ForwardRefExoticComponent<Pick<Omit<Props, keyof WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "key" | "analyticsContext" | keyof HelpLayoutProps> & React.RefAttributes<any>>;
9
+ export default _default;
@@ -0,0 +1,8 @@
1
+ import React from 'react';
2
+ import { WrappedComponentProps } from 'react-intl-next';
3
+ import { HelpLayout } from '../model/HelpLayout';
4
+ export declare const HelpContent: React.FC<HelpLayout & WrappedComponentProps>;
5
+ declare const _default: React.FC<import("react-intl-next").WithIntlProps<HelpLayout & WrappedComponentProps<"intl">>> & {
6
+ WrappedComponent: React.ComponentType<HelpLayout & WrappedComponentProps<"intl">>;
7
+ };
8
+ export default _default;
@@ -0,0 +1,11 @@
1
+ import React from 'react';
2
+ import { WrappedComponentProps } from 'react-intl-next';
3
+ export interface Props {
4
+ locale?: string;
5
+ children: React.ReactNode;
6
+ }
7
+ export declare const MessagesIntlProvider: React.FC<Props & WrappedComponentProps>;
8
+ declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps<"intl">>> & {
9
+ WrappedComponent: React.ComponentType<Props & WrappedComponentProps<"intl">>;
10
+ };
11
+ export default _default;
@@ -0,0 +1,8 @@
1
+ export declare const TRANSITION_DURATION_MS = 220;
2
+ export declare enum TRANSITION_STATUS {
3
+ UNMOUNTED = "unmounted",
4
+ EXITED = "exited",
5
+ ENTERING = "entering",
6
+ ENTERED = "entered",
7
+ EXITING = "exiting"
8
+ }
@@ -0,0 +1,17 @@
1
+ /// <reference types="react" />
2
+ /** @jsx jsx */
3
+ export declare const Container: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
4
+ export declare const Section: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
5
+ export declare const DividerLine: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
6
+ export declare const HelpFooter: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
7
+ /**
8
+ * Loading
9
+ */
10
+ export declare const LoadingContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<import("react").ClassAttributes<HTMLDivElement> & import("react").HTMLAttributes<HTMLDivElement>, keyof import("react").HTMLAttributes<HTMLDivElement>>, object>;
11
+ type LoadingRectangleProps = {
12
+ contentWidth?: string;
13
+ contentHeight?: string;
14
+ marginTop?: string;
15
+ };
16
+ export declare const LoadingRectangle: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, LoadingRectangleProps, object>;
17
+ export {};
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,4 @@
1
+ declare const _default: {
2
+ 'global_help.header': string;
3
+ };
4
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,24 @@
1
+ export { default as zh } from './zh';
2
+ export { default as cs } from './cs';
3
+ export { default as da } from './da';
4
+ export { default as nl } from './nl';
5
+ export { default as en } from './en';
6
+ export { default as en_GB } from './en_GB';
7
+ export { default as et } from './et';
8
+ export { default as fi } from './fi';
9
+ export { default as fr } from './fr';
10
+ export { default as de } from './de';
11
+ export { default as hu } from './hu';
12
+ export { default as is } from './is';
13
+ export { default as it } from './it';
14
+ export { default as ja } from './ja';
15
+ export { default as ko } from './ko';
16
+ export { default as nb } from './nb';
17
+ export { default as pl } from './pl';
18
+ export { default as pt_BR } from './pt_BR';
19
+ export { default as pt_PT } from './pt_PT';
20
+ export { default as ro } from './ro';
21
+ export { default as ru } from './ru';
22
+ export { default as sk } from './sk';
23
+ export { default as es } from './es';
24
+ export { default as sv } from './sv';
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,27 @@
1
+ declare const _default: {
2
+ zh: string;
3
+ cs: string;
4
+ da: string;
5
+ nl: string;
6
+ en: string;
7
+ en_GB: string;
8
+ et: string;
9
+ fi: string;
10
+ fr: string;
11
+ de: string;
12
+ hu: string;
13
+ is: string;
14
+ it: string;
15
+ ja: string;
16
+ ko: string;
17
+ nb: string;
18
+ pl: string;
19
+ pt_BR: string;
20
+ pt_PT: string;
21
+ ro: string;
22
+ ru: string;
23
+ sk: string;
24
+ es: string;
25
+ sv: string;
26
+ };
27
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1,2 @@
1
+ declare const _default: {};
2
+ export default _default;
@@ -0,0 +1 @@
1
+ export { default } from './components/HelpLayout';
@@ -0,0 +1,22 @@
1
+ export declare const messages: {
2
+ help_loading: {
3
+ id: string;
4
+ defaultMessage: string;
5
+ description: string;
6
+ };
7
+ help_panel_header_title: {
8
+ id: string;
9
+ defaultMessage: string;
10
+ description: string;
11
+ };
12
+ help_panel_header_back: {
13
+ id: string;
14
+ defaultMessage: string;
15
+ description: string;
16
+ };
17
+ help_panel_header_close: {
18
+ id: string;
19
+ defaultMessage: string;
20
+ description: string;
21
+ };
22
+ };
@@ -0,0 +1,14 @@
1
+ /// <reference types="react" />
2
+ import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ export interface HelpPanelHeader {
4
+ headerTitle?: string;
5
+ headerContent?: React.ReactNode;
6
+ onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
7
+ onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
8
+ isBackbuttonVisible?: boolean;
9
+ }
10
+ export interface HelpLayout extends HelpPanelHeader {
11
+ isLoading?: boolean;
12
+ footer?: React.ReactNode;
13
+ children?: React.ReactNode;
14
+ }
@@ -0,0 +1,17 @@
1
+ type LanguageCode = 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'en_GB' | 'et' | 'fi' | 'fr' | 'de' | 'hu' | 'is' | 'it' | 'ja' | 'ko' | 'nb' | 'pl' | 'pt_BR' | 'pt_PT' | 'ro' | 'ru' | 'sk' | 'es' | 'sv';
2
+ export type LangCode = LanguageCode | 'pt-BR' | 'pt-PT';
3
+ type LocaleMessages = {
4
+ [key: string]: string;
5
+ };
6
+ /**
7
+ * Tries to get the most specific messages bundle for a given locale.
8
+ *
9
+ * Strategy:
10
+ * 1. Try to find messages with the exact string (i.e. 'fr_FR')
11
+ * 2. If that doesn't work, try to find messages for the country locale (i.e. 'fr')
12
+ * 3. If that doesn't work, return english messages as a fallback.
13
+ *
14
+ * @param locale string specifying the locale like 'en_GB', or 'fr'.
15
+ */
16
+ export declare const getMessagesForLocale: (locale: LangCode) => LocaleMessages;
17
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help-layout",
3
- "version": "4.2.2",
3
+ "version": "4.2.4",
4
4
  "description": "Layout for the atlaskit/help component.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -31,12 +31,11 @@
31
31
  }
32
32
  },
33
33
  "dependencies": {
34
- "@atlaskit/analytics": "^8.1.0",
35
34
  "@atlaskit/analytics-next": "^9.1.0",
36
35
  "@atlaskit/button": "^16.7.0",
37
36
  "@atlaskit/icon": "^21.12.0",
38
37
  "@atlaskit/theme": "^12.5.0",
39
- "@atlaskit/tokens": "^1.4.0",
38
+ "@atlaskit/tokens": "^1.5.0",
40
39
  "@atlaskit/tooltip": "^17.8.0",
41
40
  "@babel/runtime": "^7.0.0",
42
41
  "@emotion/core": "^10.0.9",
@@ -53,7 +52,6 @@
53
52
  "@atlaskit/docs": "*",
54
53
  "@atlaskit/navigation": "^37.0.0",
55
54
  "@atlaskit/page": "^12.3.0",
56
- "@atlaskit/right-side-panel": "^1.2.0",
57
55
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
58
56
  "algoliasearch": "^3.35.1",
59
57
  "enzyme": "^3.10.0",