@atlaskit/flag 14.6.0 → 14.6.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/flag
 
+## 14.6.1
+
+### Patch Changes
+
+- [`45ebe7af434`](https://bitbucket.org/atlassian/atlassian-frontend/commits/45ebe7af434) - Moved to using declarative entrypoints internally. Public API is unchanged.
+- Updated dependencies
+
 ## 14.6.0
 
 ### Minor Changes

package/dist/cjs/auto-dismiss-flag.js

@@ -26,7 +26,7 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 var packageName = "@atlaskit/flag";
-var packageVersion = "14.6.0";
+var packageVersion = "14.6.1";
 var AUTO_DISMISS_SECONDS = 8;
 exports.AUTO_DISMISS_SECONDS = AUTO_DISMISS_SECONDS;
 

package/dist/cjs/flag.js

@@ -44,7 +44,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 var analyticsAttributes = {
   componentName: 'flag',
   packageName: "@atlaskit/flag",
-  packageVersion: "14.6.0"
+  packageVersion: "14.6.1"
 };
 var gridSize = (0, _constants.gridSize)();
 var doubleGridSize = gridSize * 2;

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/flag",
-	"version": "14.6.0",
+	"version": "14.6.1",
 	"sideEffects": false
 }

package/dist/es2019/auto-dismiss-flag.js

@@ -5,7 +5,7 @@ import noop from '@atlaskit/ds-lib/noop';
 import Flag from './flag';
 import { useFlagGroup } from './flag-group';
 const packageName = "@atlaskit/flag";
-const packageVersion = "14.6.0";
+const packageVersion = "14.6.1";
 export const AUTO_DISMISS_SECONDS = 8;
 
 const AutoDismissFlag = props => {

package/dist/es2019/flag.js

@@ -16,7 +16,7 @@ import { Title, Description, Expander, DismissButton } from './internal';
 const analyticsAttributes = {
   componentName: 'flag',
   packageName: "@atlaskit/flag",
-  packageVersion: "14.6.0"
+  packageVersion: "14.6.1"
 };
 const gridSize = getGridSize();
 const doubleGridSize = gridSize * 2;

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/flag",
-	"version": "14.6.0",
+	"version": "14.6.1",
 	"sideEffects": false
 }

package/dist/esm/auto-dismiss-flag.js

@@ -5,7 +5,7 @@ import noop from '@atlaskit/ds-lib/noop';
 import Flag from './flag';
 import { useFlagGroup } from './flag-group';
 var packageName = "@atlaskit/flag";
-var packageVersion = "14.6.0";
+var packageVersion = "14.6.1";
 export var AUTO_DISMISS_SECONDS = 8;
 
 var AutoDismissFlag = function AutoDismissFlag(props) {

package/dist/esm/flag.js

@@ -22,7 +22,7 @@ import { Title, Description, Expander, DismissButton } from './internal';
 var analyticsAttributes = {
   componentName: 'flag',
   packageName: "@atlaskit/flag",
-  packageVersion: "14.6.0"
+  packageVersion: "14.6.1"
 };
 var gridSize = getGridSize();
 var doubleGridSize = gridSize * 2;

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/flag",
-	"version": "14.6.0",
+	"version": "14.6.1",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/flag",
-  "version": "14.6.0",
+  "version": "14.6.1",
   "description": "A flag is used for confirmations, alerts, and acknowledgments that require minimal user interaction, often displayed using a flag group.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -16,20 +16,30 @@
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "Design System Team",
-    "deprecatedAutoEntryPoints": true,
     "releaseModel": "scheduled",
     "website": {
       "name": "Flag",
       "category": "Components"
     }
   },
+  "af:exports": {
+    ".": "./src/index.ts",
+    "./auto-dismiss-flag": "./src/auto-dismiss-flag.tsx",
+    "./constants": "./src/constants.ts",
+    "./flag-actions": "./src/flag-actions.tsx",
+    "./flag-group": "./src/flag-group.tsx",
+    "./flag-provider": "./src/flag-provider.tsx",
+    "./flag": "./src/flag.tsx",
+    "./theme": "./src/theme.ts",
+    "./types": "./src/types.ts"
+  },
   "dependencies": {
     "@atlaskit/analytics-next": "^8.0.0",
     "@atlaskit/button": "^16.3.0",
     "@atlaskit/ds-lib": "^2.0.0",
     "@atlaskit/focus-ring": "^1.0.0",
     "@atlaskit/icon": "^21.10.0",
-    "@atlaskit/motion": "^1.1.0",
+    "@atlaskit/motion": "^1.2.0",
     "@atlaskit/portal": "^4.0.0",
     "@atlaskit/theme": "^12.1.0",
     "@atlaskit/tokens": "^0.10.0",

package/report.api.md

@@ -0,0 +1,179 @@
+## API Report File for "@atlaskit/flag"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { ComponentType } from 'react';
+import { CustomThemeButtonProps } from '@atlaskit/button/types';
+import { MouseEventHandler } from 'react';
+import { default as React_2 } from 'react';
+import { ReactElement } from 'react';
+import { ReactNode } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+
+export declare type ActionsType = Array<ActionType>;
+
+declare type ActionType = {
+  content: ReactNode;
+  onClick?: (
+    e: React.MouseEvent<HTMLElement>,
+    analyticsEvent: UIAnalyticsEvent,
+  ) => void;
+  href?: string;
+  target?: string;
+  testId?: string;
+};
+
+export declare type AppearanceTypes =
+  | 'error'
+  | 'info'
+  | 'normal'
+  | 'success'
+  | 'warning';
+
+export declare const AutoDismissFlag: (
+  props: AutoDismissFlagProps,
+) => JSX.Element;
+
+declare interface AutoDismissFlagProps
+  extends AutoDismissFlagPropsWithoutId,
+    FlagPropsId {}
+
+declare type AutoDismissFlagPropsWithoutId = {
+  /** Array of clickable actions to be shown at the bottom of the flag. For flags where appearance
+   * is 'normal', actions will be shown as links. For all other appearance values, actions will
+   * shown as buttons.
+   * If href is passed the action will be shown as a link with the passed href prop.
+   */
+  actions?: ActionsType;
+  /** Makes the flag appearance bold. Setting this to anything other than 'normal' hides the
+   * dismiss button.
+   */
+  appearance?: AppearanceTypes;
+  /** The secondary content shown below the flag title */
+  description?: ReactNode;
+  /** The icon displayed in the top-left of the flag. Should be an instance of `@atlaskit/icon`.
+   * Your icon will receive the appropriate default color, which you can override by wrapping the
+   * icon in a containing element with CSS `color` set to your preferred icon color.
+   */
+  icon: ReactNode;
+  /** The bold text shown at the top of the flag. */
+  title: ReactNode;
+  /** Handler which will be called when a Flag's dismiss button is clicked.
+   * Receives the id of the dismissed Flag as a parameter.
+   */
+  onDismissed?: (id: number | string, analyticsEvent: UIAnalyticsEvent) => void;
+  /** A link component that is passed down to the `@atlaskit/button` used by actions,
+     to allow custom routers to be used. See the
+     [button with router](https://atlaskit.atlassian.com/packages/design-system/button/example/ButtonWithRouter)
+     example of what this component should look like. */
+  linkComponent?: ComponentType<CustomThemeButtonProps>;
+  /**
+     * A `testId` prop is provided for specified elements,
+     * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+
+     * Will set these elements when defined:
+
+     * - Flag root element - `{testId}`
+     * - Close button visible on default flags - `{testId}-dismiss`
+     * - Toggle button visible on bold flags - `{testId}-toggle`
+     * - Flag content which wraps the description and actions - `{testId}-expander`
+     * - Flag description - `{testId}-description`
+     * - Flag actions - `{testId}-actions`
+     */
+  testId?: string;
+  /** Additional information to be included in the `context` of analytics events that come from flag */
+  analyticsContext?: Record<string, any>;
+};
+
+declare type Combine<First, Second> = Omit<First, keyof Second> & Second;
+
+export declare interface CreateFlagArgs extends FlagPropsWithoutId {
+  /** A unique identifier used for rendering and onDismissed callbacks.
+   * This will be autogenerated if you don’t supply one.
+   * If you don’t want the same flag showing multiple times, provide a unique id.
+   */
+  id?: FlagId;
+  /** Marks whether the flag should render as an AutoDismissFlag */
+  isAutoDismiss?: boolean;
+}
+
+export declare type DismissFn = () => void;
+
+declare const Flag: (props: FlagProps) => JSX.Element;
+export default Flag;
+
+export declare type FlagAPI = {
+  showFlag: (args: CreateFlagArgs) => DismissFn;
+};
+
+export declare type FlagArgs = Combine<
+  CreateFlagArgs,
+  {
+    id: FlagId;
+  }
+>;
+
+export declare const FlagGroup: (props: FlagGroupProps) => JSX.Element;
+
+declare type FlagGroupProps = {
+  /** ID attribute used for DOM selection. */
+  id?: string;
+  /** Describes the specific role of this FlagGroup for users viewing the page with a screen reader (defaults to `Flag notifications`). */
+  label?: string;
+  /** Describes the specific tag on which the screen reader text will be rendered (defaults to `h2`). */
+  labelTag?: React.ElementType;
+  /** Flag elements to be displayed. */
+  children?: Array<ReactElement> | ReactElement | null | boolean;
+  /** Handler which will be called when a Flag's dismiss button is clicked.
+   * Receives the id of the dismissed Flag as a parameter.
+   */
+  onDismissed?: (id: number | string, analyticsEvent: UIAnalyticsEvent) => void;
+};
+
+declare type FlagId = string | number;
+
+export declare interface FlagProps extends FlagPropsWithoutId, FlagPropsId {}
+
+declare type FlagPropsId = {
+  /** A unique identifier used for rendering and onDismissed callbacks. */
+  id: number | string;
+};
+
+declare interface FlagPropsWithoutId
+  extends AutoDismissFlagPropsWithoutId,
+    WithAnalyticsEventsProps {
+  /** Standard onBlur event, applied to Flag by AutoDismissFlag */
+  onBlur?: (
+    e: React.FocusEvent<HTMLElement>,
+    analyticsEvent: UIAnalyticsEvent,
+  ) => void;
+  /** Standard onFocus event, applied to Flag by AutoDismissFlag */
+  onFocus?: (
+    e: React.FocusEvent<HTMLElement>,
+    analyticsEvent: UIAnalyticsEvent,
+  ) => void;
+  /** Standard onMouseOut event, applied to Flag by AutoDismissFlag */
+  onMouseOut?: MouseEventHandler;
+  /** Standard onMouseOver event, applied to Flag by AutoDismissFlag */
+  onMouseOver?: MouseEventHandler;
+}
+
+export declare function FlagsProvider({
+  children,
+}: {
+  children: React_2.ReactNode;
+}): JSX.Element;
+
+export declare function useFlags(): FlagAPI;
+
+export declare const withFlagsProvider: (
+  fn: () => React_2.ReactNode,
+) => React_2.ReactNode;
+
+export {};
+```