Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@atlaskit/inline-dialog

atlassian156.2kApache-2.018.0.7TypeScript support: included

An inline dialog is a pop-up container for small amounts of information. It can also contain controls.

atlaskit, react, ui

readme

Inline dialog

An inline dialog is a pop-up container for small amounts of information. It can also contain controls.

Installation

yarn add @atlaskit/inline-dialog

Usage

Detailed docs and example usage can be found here.

changelog

@atlaskit/inline-dialog

18.0.7

Patch Changes

  • Updated dependencies

18.0.6

Patch Changes

  • Updated dependencies

18.0.5

Patch Changes

  • 67dd9df06af0f - Replace instances of the a tag with Link where applicable.

18.0.4

Patch Changes

  • Updated dependencies

18.0.3

Patch Changes

  • 39e543109ec09 - add type info to forwardRef components
  • Updated dependencies

18.0.2

Patch Changes

  • 248faa32d4835 - Internal changes to how borders are applied.
  • Updated dependencies

18.0.1

Patch Changes

  • Updated dependencies

18.0.0

Major Changes

  • d636af20c6304 - This replaces react-node-resolver which uses findDOMNode under the hood with a direct ref functionality to pass the first child of an Inline Dialog around for internal use.

    There is some risk to this as while we tested this internally via a feature gate with no issues, this could be breaking in the instance where the children you pass to <InlineDialog /> is either inconsistent, or the first element is not the target we expected.

17.2.9

Patch Changes

  • 255837cfba315 - Internal changes to how border radius is applied.
  • Updated dependencies

17.2.8

Patch Changes

  • Updated dependencies

17.2.7

Patch Changes

  • 31c57f650ba07 - Improving tests for server side rendering and hydration
  • Updated dependencies

17.2.6

Patch Changes

  • Updated dependencies

17.2.5

Patch Changes

  • Updated dependencies

17.2.4

Patch Changes

  • Updated dependencies

17.2.3

Patch Changes

  • Updated dependencies

17.2.2

Patch Changes

  • Updated dependencies

17.2.1

Patch Changes

17.2.0

Minor Changes

  • #157071 a149a0b1559ec - We are testing the migration to the ADS Link component behind a feature flag. If this fix is successful it will be available in a later release.

Patch Changes

  • Updated dependencies

17.1.0

Minor Changes

  • #152852 ae720e711e4d2 - Adds fallbackPlacements prop for specifying a list of backup placements to try when the main placement does not have enough space. This matches the API of Popup.

17.0.2

Patch Changes

  • #129972 b2d69a39e6687 - Update @compiled/react dependency for improved type checking support.
  • Updated dependencies

17.0.1

Patch Changes

  • Updated dependencies

17.0.0

Major Changes

Patch Changes

  • Updated dependencies

16.2.0

Minor Changes

Patch Changes

  • Updated dependencies

16.1.3

Patch Changes

  • Updated dependencies

16.1.2

Patch Changes

  • Updated dependencies

16.1.1

Patch Changes

  • Updated dependencies

16.1.0

Minor Changes

Patch Changes

  • Updated dependencies

16.0.3

Patch Changes

16.0.2

Patch Changes

16.0.1

Patch Changes

  • Updated dependencies

16.0.0

Major Changes

  • #174572 a6642c2335879 - Migrated from @emotion/react to @compiled/react in order to improve performance, align with the rest of the Atlaskit techstack, and support React 18 Streaming SSR.

    Please note, in order to use this version of @atlaskit/inline-dialog, you will need to ensure that your bundler is configured to handle .css imports correctly. Most bundlers come with built-in support for .css imports, so you may not need to do anything. If you are using a different bundler, please refer to the documentation for that bundler to understand how to handle .css imports.

    For more information on the migration, please refer to RFC-73 Migrating our components to Compiled CSS-in-JS.

15.3.1

Patch Changes

  • Updated dependencies

15.3.0

Minor Changes

Patch Changes

  • Updated dependencies

15.2.3

Patch Changes

  • Updated dependencies

15.2.2

Patch Changes

  • #166026 962b5e77810fb - Adds side-effect config to support Compiled css extraction in third-party apps

15.2.1

Patch Changes

15.2.0

Minor Changes

15.1.2

Patch Changes

  • Updated dependencies

15.1.1

Patch Changes

  • Updated dependencies

15.1.0

Minor Changes

  • #152984 f331091d24ea4 - Bug fix for portal logic update behind ff platform_design_system_team_portal_logic_r18_fix

15.0.5

Patch Changes

  • Updated dependencies

15.0.4

Patch Changes

  • Updated dependencies

15.0.3

Patch Changes

  • Updated dependencies

15.0.2

Patch Changes

15.0.1

Patch Changes

  • Updated dependencies

15.0.0

Major Changes

14.3.1

Patch Changes

  • Updated dependencies

14.3.0

Minor Changes

  • #127511 db30e29344013 - Widening range of react and react-dom peer dependencies from ^16.8.0 || ^17.0.0 || ~18.2.0 to the wider range of ^16.8.0 || ^17.0.0 || ^18.0.0` (where applicable).

    This change has been done to enable usage of `react@18.3as well as to have a consistent peer dependency range forreactandreact-domfor/platform` packages.

Patch Changes

  • Updated dependencies

14.2.5

Patch Changes

  • Updated dependencies

14.2.4

Patch Changes

14.2.3

Patch Changes

14.2.2

Patch Changes

  • Updated dependencies

14.2.1

Patch Changes

14.2.0

Minor Changes

  • #110670 c733254a2dd6e - Explicitly set jsxRuntime to classic via pragma comments in order to avoid issues where jsxRuntime is implicitly set to automatic.

Patch Changes

  • Updated dependencies

14.1.2

Patch Changes

14.1.1

Patch Changes

  • Updated dependencies

14.1.0

Minor Changes

14.0.4

Patch Changes

14.0.3

Patch Changes

14.0.2

Patch Changes

14.0.1

Patch Changes

14.0.0

Major Changes

  • #41791 ec7c2a38247 - Removed all remaining legacy theming logic from the Calendar, Form, InlineDialog, InlineEdit and InlineMessage components.

13.6.8

Patch Changes

13.6.7

Patch Changes

  • #41435 a4eca15aedd - Enrol @atlaskit/inline-dialog into jira-frontend push model consumption

13.6.6

Patch Changes

13.6.5

Patch Changes

  • #35441 599bfe90ee3 - Internal change to use shape tokens. There is no expected visual change.

13.6.4

Patch Changes

  • #33652 e7ea6832ad2 - Bans the use of React.FC/React.FunctionComponent type in ADS components as part of the React 18 migration work. The change is internal only and should not introduce any changes for the component consumers.

13.6.3

Patch Changes

  • #34051 49b08bfdf5f - Migrated use of gridSize to space tokens where possible. There is no expected visual or behaviour change.

13.6.2

Patch Changes

13.6.1

Patch Changes

13.6.0

Minor Changes

Patch Changes

  • Updated dependencies

13.5.0

Minor Changes

  • #31299 c0dd48dfb67 - [ux] Adds keyboard support of using escape to close inline dialog.

13.4.9

Patch Changes

  • #31206 261420360ec - Upgrades component types to support React 18.
  • Updated dependencies

13.4.8

Patch Changes

  • Updated dependencies

13.4.7

Patch Changes

  • Updated dependencies

13.4.6

Patch Changes

  • #29390 18aeca8c199 - Internal change to update token references. There is no expected behaviour or visual change.

13.4.5

Patch Changes

  • Updated dependencies

13.4.4

Patch Changes

  • Updated dependencies

13.4.3

Patch Changes

  • Updated dependencies

13.4.2

Patch Changes

  • #26408 9de88fa1e1e - Internal changes to include spacing tokens in component implementations.

13.4.1

Patch Changes

13.4.0

Minor Changes

  • #24004 8d2ea17980d - Updates @emotion/core to @emotion/react; v10 to v11. There is no expected behavior change.

Patch Changes

  • Updated dependencies

13.3.9

Patch Changes

13.3.8

Patch Changes

  • #22614 8a5bdb3c844 - Upgrading internal dependency (bind-event-listener) for improved internal types

13.3.7

Patch Changes

  • Updated dependencies

13.3.6

Patch Changes

  • Updated dependencies

13.3.5

Patch Changes

  • #21242 2e7bbdfd813 - Upgrading internal dependency 'bind-event-listener' to 2.1.0 for improved types

13.3.4

Patch Changes

13.3.3

Patch Changes

  • Updated dependencies

13.3.2

Patch Changes

  • Updated dependencies

13.3.1

Patch Changes

  • Updated dependencies

13.3.0

Minor Changes

  • #18526 2a53f51adc6 - Introduce the prop strategy to allow consumers to override the default positioning strategy

Patch Changes

  • Updated dependencies

13.2.2

Patch Changes

  • #16752 19d72473dfb - Updates usage of deprecated token names so they're aligned with the latest naming conventions. No UI or visual changes
  • Updated dependencies

13.2.1

Patch Changes

  • Updated dependencies

13.2.0

Minor Changes

  • #16651 2fe0d03807f - This removes the preventDefault functionality (reverts it back to the previous version of inline dialog where event listeners were added in the capture phase). It also refactors handleClickOutside so that it is now triggered by a ref.

13.1.9

Patch Changes

  • #15998 f460cc7c411 - Builds for this package now pass through a tokens babel plugin, removing runtime invocations of the tokens() function and improving bundle size.
  • Updated dependencies

13.1.8

Patch Changes

  • Updated dependencies

13.1.7

Patch Changes

13.1.6

Patch Changes

  • #15105 cb79dfea5d9 - This fixes a bug in version 13.1.2 where inline dialog's useEffect was running synchronously and while the click event was still happening. This meant that if the open state was outside of inline dialog, there were instances where it failed to open.

13.1.5

Patch Changes

  • #14723 b94375ecf08 - Fixes issue where enzyme is unable to access component name in snapshot tests. There should be no UI or UX change.

13.1.4

Patch Changes

  • Updated dependencies

13.1.3

Patch Changes

  • #14608 0e89e593547 - Fixes a bug where the dialog was retaining its window click event listener even after the dialog was closed.

13.1.2

Patch Changes

  • #14328 398904f14d9 - [ux] Fixes a bug in version 13.1.0 where InlineDialog cannot be closed after it opens a Modal. There should be no other UI or UX changes. Note that the click event listener's capture: false has been changed to capture: true. This may cause some issues with the opening or closing of the inline dialog in some situations e.g. if the open state of the inline dialog is in an outer component. You can solve this by trying to add a preventDefault to the click handler in the outer component or changing the inline dialog's event handler to { capture: true }.

13.1.1

Patch Changes

  • Updated dependencies

13.1.0

Minor Changes

  • #13302 5a049f800d3 - Integrates the new tokens package to add support for our new theming solution. This change is fully backwards compatible with our existing theming solution
  • caec2cee6e0 - Removes styled-components dependency from the package. Also uses ThemeV2 API now. There should be no visual or UX change.

Patch Changes

  • Updated dependencies

13.0.11

Patch Changes

13.0.10

Patch Changes

  • #8644 79c23df6340 - Use injected package name and version for analytics instead of version.json.

13.0.9

Patch Changes

13.0.8

Patch Changes

  • #5497 5f58283e1f - Export types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules compiler option. This requires version 3.8 of Typescript, read more about how we handle Typescript versions here: https://atlaskit.atlassian.com/get-started Also add typescript to devDependencies to denote version that the package was built with.

13.0.7

Patch Changes

  • Updated dependencies

13.0.6

Patch Changes

13.0.5

Patch Changes

  • #3885 6c525a8229 - Upgraded to TypeScript 3.9.6 and tslib to 2.0.0

    Since tslib is a dependency for all our packages we recommend that products also follow this tslib upgrade to prevent duplicates of tslib being bundled.

13.0.4

Patch Changes

13.0.3

Patch Changes

  • Updated dependencies

13.0.2

Patch Changes

  • #3293 954cc87b62 - The readme and package information has been updated to point to the new design system website.

13.0.1

Patch Changes

13.0.0

Major Changes

Patch Changes

  • Updated dependencies

12.1.14

Patch Changes

  • #2866 54a9514fcf - Build and supporting files will no longer be published to npm

12.1.13

Patch Changes

  • Updated dependencies

12.1.12

Patch Changes

12.1.11

Patch Changes

12.1.10

Patch Changes

12.1.9

Patch Changes

12.1.8

Patch Changes

12.1.7

Patch Changes

12.1.6

Patch Changes

12.1.5

12.1.4

Patch Changes

  • [patch]a568ade043:

    Inline-dialog now correctly removes handlers when closed

12.1.3

Patch Changes

  • [patch]35d2229b2a:

    Adding missing license to packages and update to Copyright 2019 Atlassian Pty Ltd.

12.1.2

12.1.1

Patch Changes

  • [patch]a2d0043716:

    Updated version of analytics-next to fix potential incompatibilities with TS 3.6

12.1.0

Minor Changes

  • [minor]91b7a1415b:

    Adding an optional prop testId that will set the attribute value data-testid. It will help products to write better integration and end to end tests.

12.0.15

Patch Changes

  • [patch]097b696613:

    Components now depend on TS 3.6 internally, in order to fix an issue with TS resolving non-relative imports as relative imports

12.0.14

Patch Changes

12.0.13

Patch Changes

  • [patch]708028db86:

    Change all the imports to theme in Core to use multi entry points

12.0.12

Patch Changes

  • [patch]de35ce8c67:

    Updates component maintainers

12.0.11

Patch Changes

  • [patch]926b43142b:

    Analytics-next has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No behavioural changes.

    Breaking changes

    • withAnalyticsForSumTypeProps alias has been removed, please use withAnalyticsEvents
    • AnalyticsContextWrappedComp alias has been removed, please use withAnalyticsContext

    Breaking changes to TypeScript annotations

    • withAnalyticsEvents now infers proptypes automatically, consumers no longer need to provide props as a generic type.
    • withAnalyticsContext now infers proptypes automatically, consumers no longer need to provide props as a generic type.
    • Type WithAnalyticsEventProps has been renamed to WithAnalyticsEventsProps to match source code
    • Type CreateUIAnalyticsEventSignature has been renamed to CreateUIAnalyticsEvent to match source code
    • Type UIAnalyticsEventHandlerSignature has been renamed to UIAnalyticsEventHandler to match source code
    • Type AnalyticsEventsPayload has been renamed to AnalyticsEventPayload
    • Type ObjectType has been removed, please use Record<string, any> or [key: string]: any
    • Type UIAnalyticsEventInterface has been removed, please use UIAnalyticsEvent
    • Type AnalyticsEventInterface has been removed, please use AnalyticsEvent
    • Type CreateAndFireEventFunction removed and should now be inferred by TypeScript
    • Type AnalyticsEventUpdater removed and should now be inferred by TypeScript

12.0.10

Patch Changes

  • [patch]688f2957ca:

    Fixes various TypeScript errors which were previously failing silently

12.0.9

Patch Changes

  • [patch]f34776be97:

    Type definition files are now referenced in package.json

12.0.8

12.0.7

Patch Changes

  • [patch]9f8ab1084b:

    Consume analytics-next ts type definitions as an ambient declaration.

12.0.6

Patch Changes

  • [patch]d0db01b410:

    TypeScript users of withAnalyticsEvents and withAnalyticsContext are now required to provide props as a generic type. This is so that TypeScript can correctly calculate the props and defaultProps of the returned component.

    Before:

    withAnalyticsEvents()(Button) as ComponentClass<Props>;

    After:

    withAnalyticsEvents<Props>()(Button);

12.0.5

12.0.4

12.0.3

12.0.2

Patch Changes

12.0.1

12.0.0

Major Changes

  • [major]181209d135:
    • @atlaskit/inline-dialog has been converted to Typescript. Typescript consumers will now get static type safety. Flow types are no longer provided. No API or behavioural changes.

11.0.1

  • [patch]21854842b5:
    • Clean couple of TODO's that were already done

11.0.0

  • [major]7c17b35107:
    • Updates react and react-dom peer dependencies to react@^16.8.0 and react-dom@^16.8.0. To use this package, please ensure you use at least this version of react and react-dom.

10.0.5

10.0.4

10.0.3

10.0.2

  • [patch]da6ef8b69a:
    • Using new z-index values from theme

10.0.1

10.0.0

  • [major]76299208e6:

    • Drop ES5 from all the flow modules

    Dropping CJS support in all @atlaskit packages

    As a breaking change, all @atlaskit packages will be dropping cjs distributions and will only distribute esm. This means all distributed code will be transpiled, but will still contain import and export declarations.

    The major reason for doing this is to allow us to support multiple entry points in packages, e.g:

    import colors from `@atlaskit/theme/colors`;

    Previously this was sort of possible for consumers by doing something like:

    import colors from `@atlaskit/theme/dist/esm/colors`;

    This has a couple of issues. 1, it treats the file system as API making internal refactors harder, we have to worry about how consumers might be using things that aren't actually supposed to be used. 2. We are unable to do this internally in @atlaskit packages. This leads to lots of packages bundling all of theme, just to use a single color, especially in situations where tree shaking fails.

    To support being able to use multiple entrypoints internally, we unfortunately cannot have multiple distributions as they would need to have very different imports from of their own internal dependencies.

    ES Modules are widely supported by all modern bundlers and can be worked around in node environments.

    We may choose to revisit this solution in the future if we find any unintended condequences, but we see this as a pretty sane path forward which should lead to some major bundle size decreases, saner API's and simpler package architecture.

    Please reach out to #fabric-build (if in Atlassian) or create an issue in Design System Support (for external) if you have any questions or queries about this.

9.0.15

9.0.14

9.0.13

9.0.12

9.0.11

9.0.10

9.0.9

9.0.8

9.0.7

  • [patch] Adds missing implicit @babel/runtime dependency b71751b

9.0.6

9.0.5

9.0.4

  • [patch] Adds sideEffects: false to allow proper tree shaking b5d6d04

9.0.2

9.0.1

  • [patch] Added z-index back and fixed onClose d9a0c62
  • [none] Updated dependencies d9a0c62

9.0.0

8.0.4

8.0.3

8.0.2

8.0.1

8.0.0

7.1.3

7.1.2

7.1.1

7.1.0

7.0.2

  • [patch] Fix InlineDialog closing on Select option click. Added Select prop onClickPreventDefault which is enabled by default 11accbd
  • [patch] Updated dependencies 11accbd

7.0.1

7.0.0

6.0.2

6.0.0

  • [major] Bump to React 16.3. 4251858

5.3.2

  • [patch] Re-releasing due to potentially broken babel release 9ed0bba

5.3.1

  • [patch] Removed focus ring from inline-dialogs focused via the mouse a17adde

5.3.0

  • [minor] Update styled-components dependency to support versions 1.4.6 - 3 ceccf30

5.2.2

5.2.1

  • [patch] Packages Flow types for elements components 3111e74

5.2.0

  • [minor] Updated inline-dialog to include boundaries element prop, updated Layer to have dynamic boolean escapeWithReference property, updated modal-dialog Content component with overflow-x:hidden' cb72752

5.1.2

  • [patch] Revert name of stateless export to InlineEditStateless fffacd6

5.1.1

  • [patch] Resolved low hanging flow errors in field-base field-text comment icon item and website, $ 007de27

5.1.0

  • [minor] Add React 16 support. 12ea6e4

5.0.7

  • [patch] moved react-dom to peer dependency 214dd1f

5.0.6

  • [patch] migrated inline dialog from ak to mk2 9feaa91

5.0.5 (2017-11-24)

  • bug fix; prevent inline-dialog from closing when event is prevented and prevent default for c (issues closed: ak-3870) (8ae0c3b)

5.0.4 (2017-10-26)

  • bug fix; fix to rebuild stories (793b2a7)

5.0.3 (2017-10-22)

  • bug fix; update styled component dependency and react peerDep (39f3286)

5.0.2 (2017-10-03)

  • bug fix; refactored how inline-dialog handles max-width in order to better support scrollable (20b62a6)

5.0.1 (2017-08-21)

  • bug fix; fix PropTypes warning (040d579)

5.0.0 (2017-08-11)

  • bug fix; fix the theme-dependency (db90333)
  • bug fix; inline-dialog: fix vertical padding (49d8c5d)
  • bug fix; inline-dialog: updates from design review (ff38fa2)
  • breaking; affects internal styled-components implementation (d14522a)
  • breaking; implement dark mode theme (d14522a)

4.0.0 (2017-08-11)

  • bug fix; inline-dialog: fix vertical padding (49d8c5d)
  • bug fix; inline-dialog: updates from design review (ff38fa2)
  • breaking; affects internal styled-components implementation (d14522a)
  • breaking; implement dark mode theme (d14522a)

3.6.2 (2017-07-27)

  • fix; rename jsnext:main to jsnext:experimental:main temporarily (c7508e0)

3.6.1 (2017-07-25)

  • fix; use class transform in loose mode in babel to improve load performance in apps (fde719a)

3.3.0 (2017-07-17)

  • fix; rerelease, failed prepublish scripts (5fd82f8)
  • feature; added ES module builds to dist and add jsnext:main to most ADG packages (ea76507)

3.2.1 (2017-07-13)

  • fix; add prop-types as a dependency to avoid React 15.x warnings (92598eb)

3.2.0 (2017-05-16)

  • feature; bumping util-shared-styles in inline-dialog (429e23a)

3.1.2 (2017-04-27)

  • fix; update legal copy to be more clear. Not all modules include ADG license. (f3a945e)

3.1.1 (2017-04-26)

  • fix; update legal copy and fix broken links for component README on npm. New contribution and (0b3e454)

3.1.0 (2017-04-18)

  • feature; allow inline dialog to be closed via document click (bdc7dc5)
  • breaking; added ReactDOM as a peerDependency
  • ISSUES CLOSED: AK-2069

2.0.0 (2017-03-31)

  • refactor the inline-dialog component to use styled-components (85294ec)
  • feature; Allow an array of positions to be passed to the shouldFlip property (1a2a3f6)
  • breaking; added peerDependency "styled-components”
  • ISSUES CLOSED: AK-1988, AK-1996

1.1.0 (2017-03-28)

  • feature; add onContentClick property to inline-dialog (ff7404e)
  • feature; add onContentFocus and onContentBlur properties to inline-dialog (9cc1663)

1.0.7 (2017-03-23)

  • fix; Empty commit to release the component (49c08ee)

1.0.5 (2017-03-21)

  • fix; maintainers for all the packages were added (261d00a)

1.0.4 (2017-02-20)

  • fix; use correctly scoped package names in npm docs (91dbd2f)

1.0.3 (2017-02-09)

  • fix; avoiding binding render to this (40c9951)

1.0.2 (2017-02-07)

  • fix; allow inline dialog trigger to take full width (38325fc)

1.0.1 (2017-02-06)

  • fix; Updates package to use scoped ak packages (38fca7c)