Terra Popup

The Terra Popup is higher order component that launches terra-hookshot positioned content with the ability to display a dynamic arrow.

• Getting Started
• Documentation
• LICENSE

Getting Started

• Install from npmjs: npm install terra-popup

Peer Dependencies

This component requires the following peer dependencies be installed in your app for the component to properly function.

Documentation

Documentation for this component is spilt into individual files. One file for the main component and one file for each component modifier.

See the documentation.

LICENSE

Copyright 2017 - 2020 Cerner Innovation, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Changelog

Unreleased

6.85.1 - (May 24, 2024)

• Changed
  • Minor dependency version bump.

6.85.0 - (May 22, 2024)

• Changed
  • Minor dependency version bump.

6.84.0 - (May 20, 2024)

• Changed
  • Enabled close button in popup by default.

6.83.0 - (May 14, 2024)

• Changed
  • Minor dependency version bump.

6.82.0 - (May 8, 2024)

• Changed
  • Minor dependency version bump.

6.81.0 - (May 1, 2024)

• Changed
  • Added event handlers to call stopPropagation() on key and focus events on PopupContent in other components.

6.80.0 - (April 4, 2024)

• Changed
  • Minor dependency version bump.

6.79.0 - (March 25, 2024)

• Changed
  • Allow popup to pass through custom props

6.78.0 - (March 14, 2024)

• Changed
  • Minor dependency version bump.

6.77.0 - (March 8, 2024)

• Changed
  • Minor dependency version bump.

6.76.0 - (March 5, 2024)

• Changed
  • Minor dependency version bump.

6.75.0 - (February 28, 2024)

• Changed
  • Minor dependency version bump.

6.74.0 - (January 22, 2024)

• Changed
  • Minor dependency version bump.

6.73.0 - (December 18, 2023)

• Changed
  • Minor dependency version bump.

6.72.0 - (November 23, 2023)

• Changed
  • Minor dependency version bump

6.71.1 - (October 11, 2023)

• Fixed
  • Fixed popup click events propagating to elements underneath it.

6.71.0 - (October 3, 2023)

• Added
  • Added aria-label prop for terra-popup to announce the close instruction.

6.70.1 - (August 4, 2023)

• Changed
  • Minor dependency version bump

6.70.0 - (July 31, 2023)

• Changed
  • Minor dependency version bump

6.69.0 - (July 25, 2023)

• Changed
  • Minor dependency version bump

6.68.0 - (July 19, 2023)

• Changed
  • Minor dependency version bump

6.67.0 - (June 5, 2023)

• Updated contentWidth with value 400.

6.66.0 - (May 11, 2023)

• Changed
  • Updated close handler to return focus to target object upon pop-up closure.

6.65.0 - (April 27, 2023)

• Changed
  • Minor dependency version bump

6.64.0 - (March 29, 2023)

• Changed
  • Updated Jest snapshots.

6.63.0 - (March 1, 2023)

• Changed
  • Updated Jest snapshot for terra-button changes

6.62.0 - (February 14, 2023)

• Changed
  • Updated WDIO screenshots due to webpack-config-terra and terra-functional-testing upgrade.

6.61.0 - (March 15, 2022)

• Added
  • Migrate docs to terra-framework-docs.

6.60.0 - (November 16, 2021)

• Changed
  • Minor dependency version bump

6.59.0 - (November 9, 2021)

• Changed
  • Minor dependency version bump

6.58.0 - (October 14, 2021)

• Fixed
  • Reverted focus-trap-react upgrade due to passivity concerns

6.57.0 - (October 12, 2021)

• Changed
  • Upgrade focus-trap-react to version ^8.0.0.

6.56.0 - (September 20, 2021)

• Changed
  • Updated WDIO screenshots due to webpack-config-terra sass upgrade.
  • Updated WDIO snapshots due to terra-functional-testing v2 upgrade.

6.55.0 - (July 21, 2021)

• Changed
  • Minor dependency version bump

6.54.0 - (July 13, 2021)

• Changed
  • Minor dependency version bump

6.53.0 - (June 8, 2021)

• Changed
  • Minor dependency version bump

6.52.0 - (May 4, 2021)

• Changed
  • Minor dependency version bump

6.51.0 - (April 6, 2021)

• Changed
  • Updated Jest command

6.50.0 - (March 9, 2021)

• Changed
  • Updated to use terra-functional-testing

6.49.0 - (February 9, 2021)

• Changed
  • Minor dependency version bump

6.48.0 - (February 2, 2021)

• Changed
  • Minor dependency version bump

6.47.0 - (January 26, 2021)

• Changed
  • Minor dependency version bump

6.46.0 - (January 5, 2021)

• Changed
  • Updated to support a peer dependency of react-intl v2-v5
  • Updated FormattedMessage child function to join if given an array.

6.45.0 - (December 8, 2020)

• Changed
  • Minor dependency version bump

6.44.0 - (November 24, 2020)

• Changed
  • Update wdio tests to remove deprecated Terra.it helpers

6.43.0 - (November 10, 2020)

• Fixed
  • Fixed build failures due to the react/sort-comp rule

6.42.0 - (October 20, 2020)

• Changed
  • Minor dependency version bump

6.41.0 - (October 13, 2020)

• Changed
  • Replaced references to terra-doc-template with terra-docs

6.40.0 - (August 18, 2020)

• Changed
  • Minor dependency version bump

6.39.0 - (August 11, 2020)

• Changed
  • Minor dependency version bump

6.38.0 - (August 4, 2020)

• Changed
  • Updated Changelog format

6.37.0 - (July 14, 2020)

• Changed
  • Minor file changes to comply with eslint rules
  • Replace some empty text with aria-label to comply with eslint

6.36.0 - (June 16, 2020)

• Changed
  • Minor dependency version bump

6.35.0 - (June 9, 2020)

• Changed
  • Apply themes by context and directly include packaged themes.

6.34.0 - (June 2, 2020)

• Changed
  • Minor dependency version bump

6.33.0 - (May 19, 2020)

• Changed
  • Minor dependency version bump

6.32.0 - (April 28, 2020)

• Added

  • Added directory as a sub attribute to the repository attribute in package.json

• Changed

  • Update wdio test configuration to use root wdio config

• Removed

  • Removed "View Component Source Code" from docs in favour of source code badge

6.31.0 - (April 6, 2020)

• Changed
  • Minor dependency version bump

6.30.0 - (March 31, 2020)

• Added
  • Added clinical-lowlight-theme wdio screenshots

6.29.0 - (March 10, 2020)

• Changed
  • Update docs to use MDX syntax.

6.28.0 - (March 3, 2020)

• Changed
  • Minor dependency version bump

6.26.0 - (February 18, 2020)

• Added
  • Added clinical-lowlight-theme theming files

6.25.0 - (February 4, 2020)

• Changed
  • Minor dependency version bump

6.24.0 - (January 28, 2020)

• Changed
  • Update copyright to include 2020

6.23.0 - (January 7, 2020)

• Changed
  • Minor dependency version bump

6.22.0 - (December 16, 2019)

• Changed
  • Updated Jest snapshots.

6.21.0 - (December 10, 2019)

• Added
  • Added orion-fusion-theme and generated the respective reference wdio screenshots.

6.20.0 - (November 20, 2019)

• Changed
  • Minor dependency updates

6.19.0 - (November 18, 2019)

• Changed
  • Minor dependency updates

6.18.0 - (November 7, 2019)

• Changed
  • Updated examples to use hooks
  • Resolved lint warnings for multiple empty lines

6.17.0 - (October 30, 2019)

• Changed
  • Minor dependency updates

6.16.0 - (October 21, 2019)

• Changed
  • Minor dependency updates

6.15.0 - (October 16, 2019)

• Changed
  • Minor dependency updates

6.14.0 - (October 3, 2019)

• Changed
  • Minor dependency updates

6.13.0 - (September 26, 2019)

• Changed

  • Minor dependency updates

• Added

  • Added private prop popupContentRole intend to allow modification of the role attribute applied to the <PopupContent /> component used with the <Popup /> component

• Changed

  • Reverted Placeholder import in example files.

6.12.0 - (September 19, 2019)

• Changed

  • Removed details tag from doc-site.
  • Doc site example module import syntax modified to use package.json name resolution

• Added

  • Added en-CA translations.

6.11.0 - (September 6, 2019)

• Changed
  • Cleaned up imports in examples and test files

6.10.0 - (August 21, 2019)

• Changed
  • Cleaned up lint in test files

6.9.0 - (August 14, 2019)

• Changed

  • updated package.json test scripts

• Removed

  • Removed themeable variable for z-index, short not be based upon theme

6.8.0 - (July 30, 2019)

• Removed
  • Removed DEPENDENCIES.md file

6.7.1 - (July 23, 2019)

• Changed
  • Updated DEPENDENCIES.md doc

6.7.0 - (July 23, 2019)

• Changed
  • Minor dependency version bump

6.6.0 - (July 16, 2019)

• Added
  • Added documentation on required peerDependencies

6.5.0 - (July 10, 2019)

• Changed
  • Minor dependency version bump

6.4.0 - (July 2, 2019)

• Changed
  • Renamed test and example SCSS files to end with .module.scss extension

6.3.0 - (June 19, 2019)

• Changed
  • Removed all inline styles from Dev-site components and implemented the same styles using external css.

6.2.0 - (June 12, 2019)

• Removed

  • Removed node_modules from .npmignore

• Changed

  • Update tests for terra-toolkit v5 and terra-dev-site v5 changes
  • Update wdio specs to use Terra.describeViewports

6.1.0 - (May 21, 2019)

• Changed
  • Minor dependency update

6.0.0 - (May 13, 2019)

• Breaking Change
  • Removed releaseFocus prop
  • Removed requestFocus prop
  • Updated focus-trap-react dependency to ^6.0.0

5.12.0 - (May 7, 2019)

• Changed
  • Minor dependency update

5.11.0 - (April 24, 2019)

• Changed
  • Moved packages we use solely in doc examples and tests to devDependencies

5.10.0 - (April 16, 2019)

• Changed
  • Minor dependency update

5.9.0 - (April 9, 2019)

• Changed
  • Minor dependency update

5.8.0 - (April 2, 2019)

• Changed
  • Minor dependency update

5.7.0 - (March 26, 2019)

• Changed

  • Update react/react-dom peer-dependency to latest stable minor release

• Removed

  • Removed peer dependency on terra-base
  • Removed baseStyles import from terra-base

5.6.0 - (March 20, 2019)

• Changed
  • Updated heading levels in doc site README.md to correct Section 508 errors
  • Update Jest tests to use terra-enzyme-intl

5.5.0 - (March 12, 2019)

• Changed
  • Minor dependency update

5.4.0 - (March 5, 2019)

• Fixed

  • Remove Opts export, instead named export cornerSize

• Changed

  • Remove need to use injectIntl, use <FormattedMessage /> instead
  • Updated docs

5.3.0 - (February 26, 2019)

• Added

  • Added en-AU translations

• Fixed

  • Removed prop breaking the modal example

5.2.0 - (February 13, 2019)

• Changed
  • Removed dependency on terra-list
  • Removed dependency on terra-grid

5.1.0 - (February 5, 2019)

• Changed
  • Minor dependency update

5.0.0 - (January 25, 2019)

• Breaking Change

  • Updated variable names to match new naming standard
  • Added new variables for css theming
  • Removed variables for css theming
  • Updated terra-core dependencies

• Fixed

  • Removed 'close' class from _PopupContent button
  • Added text prop to _PopupContent button for conversion to aria-label in Button component

• Added

  • react-intl dependency added for i18n translations
  • intl prop added to _PopupContent for i18n message formatting

• Changed

  • Remove use of componentWillReceiveProps

4.22.0 - (January 5, 2019)

• Changed
  • Minor dependency update

4.21.0 - (January 2, 2019)

• Changed
  • Prevent click events from propagating from popup overlay

4.20.0 - (December 5, 2018)

• Added

  • Added onClickOutside detection to popup overlay

• Changed

  • Replaced hookshot content component with a version that does not use onClickOutside HOC
  • Disabled focus trap when popup is open and users click outside of the popup

4.19.1 - (December 3, 2018)

• Changed

  • Wdio tests changed to use themeCombinationOfCustomProperties
  • Replaced use of componentWillMount with componentDidMount

• Fixed

  • Fixed preventDefault error

• Changed

  • Updated examples to consume terra-disclosure-manager v3.x

• Removed

  • Removed dependency on terra-app-delegate package.

4.18.1 - (November 15, 2018)

• Changed
  • Patch dependency update

4.18.0 - (November 15, 2018)

• Changed
  • Minor dependency update

4.17.0 - (October 30, 2018)

• Changed
  • Update mixin import to be more explicit

4.16.0 - (October 16, 2018)

• Changed
  • Updated popup examples to highlight how to achieve better focus management for screen readers

4.15.0 - (October 8, 2018)

• Changed

  • Updated links in docs on supported features
  • Upgrade focus-trap-react version to ^4.0.1

• Added

  • Webdriver theme test for --terra-popup-arrow-inner-color

4.14.0 - (September 25, 2018)

• Changed
  • Minor dependency bump

4.13.0 - (September 5, 2018)

• Changed
  • Bumped minimum react peerDependency version from ^16.2.0 to ^16.4.2
  • Bumped minimum react-dom peerDependency version from ^16.2.0 to ^16.4.2

4.12.0 - (August 30, 2018)

• Changed
  • Formatting changes per eslint v5 update

4.11.0 - (August 13, 2018)

• Changed
  • Minor dependency updates

4.10.0 - (August 8, 2018)

• Changed

  • Formatting changes per eslint v4 update

• Fixed

  • Lint errors regarding file path resolution
  • Popup Content will clone prop to indicate missing close button

4.9.0 - (July 26, 2018)

• Changed
  • Minor dependency updates

4.8.0 - (July 25, 2018)

• Changed
  • Add .module extension to SCSS file(s)

4.7.0 - (July 10, 2018)

• Changed
  • Clean up dependencies

4.6.0 - (July 3, 2018)

• Added
  • Change logs to documentation on terra-dev-site

4.5.0 - (June 29, 2018)

• Changed
  • Minor dependency updates

4.4.0 - (June 12, 2018)

• Changed
  • Minor dependency updates

4.3.0 - (June 5, 2018)

• Changed
  • Minor dependency updates

4.2.0 - (May 30, 2018)

• Changed
  • Moved examples to src

4.1.0 - (May 22, 2018)

• Changed
  • Minor dependency updates

4.0.0 - (May 8, 2018)

• Major Change

  • Updated to use terra-modal-manager v3.0.0

• Changed

  • Update webdriver screenshots

3.3.0 - (April 30, 2018)

• Changed
  • Minor dependency updates
  • Do not release snapshots to npm

3.2.0 - (April 20, 2018)

• Changed
  • Added a call to preventDefault on onOutsideClick

3.1.0 - (April 13, 2018)

• Changed
  • Minor dependency updates

3.0.0 - (April 10, 2018)

• Breaking Change
  • Removed attachment behavior none. Added push as a replacement to none to regain previous bounded repositioning.

2.4.1 - (April 5, 2018)

• Changed
  • Added terra-mixins dependency

2.4.0 - (April 3, 2018)

• Changed
  • Miragte package to terra-framework

2.3.0 - (March 14, 2018)

• Changed
  • Allow Popup 'Up' Arrow to be themed

2.2.0 - (March 6, 2018)

• Removed
  • Removed props-table script from package.json

2.1.0 - (February 26, 2018)

• Changed
  • Updated WebDriverIO tests

2.0.1 - (February 13, 2018)

• Changed
  • Updated peerDependencies

2.0.0 - (February 12, 2018)

• Changed

  • Updated to use React 16

• Added

  • WebDriverIO tests and themable styles

1.20.0 - (February 1, 2018)

• Changed
  • Minor version bump

1.19.0 - (January 18, 2018)

• Changed
  • Minor version bump

1.18.0 - (January 5, 2018)

• Fixed
  • Console warning

1.17.0 - (December 5, 2017)

• Changed
  • Minor version bump

1.16.0 - (November 28, 2017)

• Changed
  • Minor version bump

1.15.0 - (November 16, 2017)

• Changed
  • Minor version bump

1.14.0 - (November 7, 2017)

• Changed
  • Minor version bump

1.13.0 - (October 31, 2017)

• Added
  • Consume content resize prop on HookshotContent

1.12.0 - (October 24, 2017)

• Changed
  • Replaced tether implementation with terra-hookshot components

1.11.0 - (October 6, 2017)

• Changed
  • Minor version bump

1.10.0 - (September 26, 2017)

• Removed
  • Remove stylelint-disable selector-class-pattern

1.9.0 - (September 19, 2017)

• Changed
  • Minor version bump

1.8.0 - (September 12, 2017)

• Changed

  • Fix -var() syntax.

• Fixed

  • Implementation of the overlay styling.

1.7.0 - (September 7, 2017)

• Changed
  • Minor version bump

1.6.0 - (September 5, 2017)

• Changed
  • Update nightwatch tests and test scripts.

1.5.0 - (August 31, 2017)

• Changed
  • Minor version bump

1.4.0 - (August 15, 2017)

• Changed
  • Switched CSS custom properties usage to inline fallback syntax

1.3.0 - (August 8, 2017)

• Changed
  • Minor version bump

1.2.0 - (August 1, 2017)

• Changed
  • Minor version bump

1.1.0 - (August 1, 2017)

• Added

  • Added requestFocus and releaseFocus props to support requesting and releasing focus.

• Fixed

  • Prevent Invalid Props from breaking size logic. (Issue #679)

1.0.0 - (July 26, 2017)

Initial stable release