Détail du package

terra-avatar

cerner4.8kApache-2.03.21.0

Contains components that represent a person, location or entity. Variants include Avatar, Facility, and Generic.

Avatar, Cerner, Terra, terra-avatar

readme

Terra Avatar

NPM version Build Status

The terra-avatar component displays an avatar, which can be either an image or text, in a circular frame. If neither an image or text is provided, a variant-based fallback icon is used.

Getting Started

  • Install from npmjs: npm install terra-avatar

Peer Dependencies

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

Peer Dependency Version
react ^16.8.5
react-dom ^16.8.5

LICENSE

Copyright 2018 - 2019 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

Changelog

Unreleased

3.21.0 - (May 24, 2024)

  • Changed
    • Minor dependency version bump.

3.20.0 - (February 20, 2024)

  • Changed
    • Minor dependency version bump.

3.19.0 - (February 15, 2024)

  • Changed
    • Minor dependency version bump.

3.18.0 - (November 13, 2023)

  • Changed
    • Minor dependency version bump

3.17.0 - (March 1, 2023)

  • Added
    • Updated alt prop to include Deceased string when isDeceased prop is set based on its value.

3.16.0 - (February 15, 2023)

  • Changed
    • Updated wdio screenshots due to functional-testing upgrade.

3.15.1 - (January 31, 2023)

  • Changed
    • Minor dependency version bump of terra-image

3.15.0 - (December 7, 2022)

  • Changed
    • Minor dependency version bump

3.14.1 - (January 4, 2022)

  • Changed
    • Minor dependency version bump

3.14.0 - (September 28, 2021)

  • Changed
    • migrate doc to terra-core-docs

3.13.0 - (September 21, 2021)

  • Changed
    • Minor dependency version bump

3.12.0 - (April 6, 2021)

  • Changed
    • Upgrade tests to terra-functional-testing and WebDriverIO v6
    • Removed unnecessary wdio.conf.js file
    • Updated jest tests to not require a jpg mock.

3.11.0 - (January 5, 2021)

  • Fixed
    • Fixed broken links in documentation.

3.10.0 - (December 8, 2020)

  • Changed
    • Minor dependency version bump

3.9.0 - (November 17, 2020)

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

3.8.0 - (August 4, 2020)

  • Changed
    • Minor dependency version bump

3.7.0 - (July 29, 2020)

  • Changed
    • Update changelog formatting

3.6.0 - (July 7, 2020)

  • Changed
    • Minor dependency version bump

3.5.0 - (June 9, 2020)

  • Changed
    • Update wdio test configuration to use root wdio config

3.4.0 - (June 2, 2020)

  • Fixed
    • Updated jest snapshots for terra-image change.

3.3.0 - (May 19, 2020)

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

3.2.0 - (April 28, 2020)

  • Changed
    • Removed "View Component Source Code" from docs in favour of source code badge
  • Added
    • Added clinical-lowlight-theme wdio screenshots

3.1.0 - (April 22, 2020)

  • Changed
    • Updated documentation links
    • Removed extra lines from README

3.0.0 - (March 31, 2020)

  • Breaking Change
    • Changed the fallback behavior of Avatar. Such that if the image fails to load, the avatar falls back to the initials display instead of default user icon.
    • To Make all User avatars available in same variant generic subcomponent has been added.
    • generic subcomponent replaces the sharedUser subcomponent.
    • generic subcomponent contains a variant prop that toggles between single-user, shared-user, and provider user avatar.
    • user avatar has been moved into generic sub-comopnent with varaint name single-user.

2.36.0 - (March 10, 2020)

  • Changed
    • Minor dependency version bump

2.35.0 - (February 25, 2020)

  • Changed
    • Minor dependency version bump

2.34.0 - (February 18, 2020)

  • Added
    • Added clinical-lowlight-theme theming files

2.33.0 - (February 4, 2020)

  • Changed
    • Update docs to use MDX syntax

2.32.0 - (January 7, 2020)

  • Changed
    • Minor dependency version bump

2.31.0 - (December 3, 2019)

  • Added

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

  • Fixed

    • Updated snapshots for terra-image change.

2.30.0 - (October 30, 2019)

  • Fixed
    • Fixed lint warnings for multiple empty lines

2.29.0 - (October 3, 2019)

  • Changed
    • Minor dependency version bump

2.28.0 - (September 26, 2019)

  • Changed
    • Minor dependency version bump

2.27.0 - (September 19, 2019)

  • Changed

    • Removed details tag from doc-site.

  • Added

    • Introduce background-clip themeable variable.

2.26.0 - (September 6, 2019)

  • Added
    • Props table markdown file import added to doc site page

2.25.0 - (August 21, 2019)

  • Changed
    • Import for package version from package.json added to doc page
    • Switch from Object.assign to Object spread syntax.
    • Cleaned up imports in examples and test files

2.24.0 - (August 14, 2019)

  • Fixed

    • Fixed issue for avatar to allow non-square images by sending Fit as cover.

  • Changed

    • updated package.json test scripts

2.23.0 - (July 30, 2019)

  • Changed
    • Minor dependency version bump

2.22.0 - (July 24, 2019)

  • Changed
    • Minor dependency version bump

2.21.0 - (July 16, 2019)

  • Added
    • Added documentation on required peerDependencies

2.20.0 - (July 11, 2019)

  • Changed
    • Minor dependency version bump

2.19.0 - (July 9, 2019)

  • Changed
    • Update tests to use Terra.describeViewports for setting viewports

2.18.0 - (June 28, 2019)

  • Changed
    • Minor dependency version bump

2.17.0 - (June 18, 2019)

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

2.16.0 - (June 11, 2019)

  • Removed

    • Removed node_modules from .npmignore

  • Changed

    • Made required updates to consume terra-toolkit v5 and terra-dev-site v5

2.15.0 - (May 1, 2019)

  • Changed
    • Minor dependency version bump

2.14.0 - (April 16, 2019)

  • Changed
    • Minor dependency version bump

2.13.0 - (April 2, 2019)

  • Changed
    • Minor dependency version bump

2.12.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

2.11.0 - (March 21, 2019)

  • Changed
    • Removed terra-form-select dependency

2.10.0 - (March 6, 2019)

  • Changed
    • Minor dependency version bump

2.9.0 - (March 5, 2019)

  • Fixed

    • Fallback icon on invalid image now renders correctly.

  • Added

    • CSS classes to handle fallback and deceased edge cases.

2.8.0 - (February 26, 2019)

  • Changed
    • Minor dependency version bump

2.7.0 - (February 12, 2019)

  • Changed
    • Minor dependency version bump

2.6.0 - (February 5, 2019)

  • Changed
    • Minor dependency version bump

2.5.0 - (January 28, 2019)

  • Changed
    • Minor dependency version bump

2.4.0 - (January 26, 2019)

  • Changed
    • Minor dependency version bump

2.3.0 - (January 22, 2019)

  • Changed
    • Minor dependency version bump

2.2.0 - (January 22, 2019)

  • Fixed
    • Refactor 'netraul' theme var to 'neutral'

2.1.0 - (January 8, 2019)

  • Changed
    • Added theme variable change to upgrade guide

2.0.0 - (January 2, 2019)

  • Breaking Change

    • Removed variant prop
    • Initials prop now only accepts one or two letters

  • Changed

    • Split avatar into three functional sub-components - avatar, facility, and shared user.
    • Split theme tests into their own package
    • Refactor box shadow to after element

  • Added

    • Added color variants
    • Added alt, color, hashValue, isDeceased, isAriaHidden, and size props

1.29.0 - (November 19, 2018)

  • Changed
    • Minor dependency version bump

1.28.0 - (November 13, 2018)

  • Changed
    • Minor dependency version bump

1.27.0 - (November 9, 2018)

  • Changed
    • Minor dependency version bump

1.26.0 - (October 30, 2018)

  • Changed
    • Update mixin import to be more explicit

1.25.0 - (October 24, 2018)

  • Changed
    • Minor dependency version bump

1.24.0 - (October 16, 2018)

  • Changed
    • Minor dependency version bump

1.23.0 - (October 8, 2018)

  • Changed
    • Minor dependency version bump

1.22.0 - (October 2, 2018)

  • Changed
    • Minor dependency version bump

1.21.0 - (September 25, 2018)

  • Changed
    • Minor dependency version bump

1.20.1 - (September 6, 2018)

  • Changed
    • Patch dependency version bump

1.20.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

1.19.0 - (September 4, 2018)

  • Changed
    • Minor dependency version bump

1.18.0 - (August 29, 2018)

  • Changed
    • Minor dependency version bump

1.17.0 - (August 1, 2018)

  • Changed
    • Minor dependency version bump

1.16.0 - (July 19, 2018)

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

1.15.0 - (July 17, 2018)

  • Changed
    • Minor dependency version bump
    • Formatting changes per eslint v4 update

1.14.0 - (July 10, 2018)

  • Changed
    • Minor dependency version bump

1.13.0 - (June 28, 2018)

  • Changed

    • Minor dependency version bump

  • Fixed

    • Fixed bug with extra space showing below image avatar

  • Added

    • Added change log to the documentation on terra-dev-site

1.12.0 - (June 22, 2018)

  • Changed
    • Moved terra-base from dependency to peerDependency

1.11.0 - (June 12, 2018)

  • Changed

    • Updated "test:jest" script to work on windows.

  • Fixed

    • Fixed image flickering when updating image, alt, or variant props

1.10.0 - (May 30, 2018)

  • Changed
    • Updated structure to match terra-dev-site 1.0 and moved doc examples internal.

1.9.0 - (May 23, 2018)

  • Changed
    • Minor dependency version bump

1.8.0 - (May 16, 2018)

  • Changed
    • Minor dependency version bump

1.7.0 - (May 9, 2018)

  • Changed
    • Minor dependency version bump

1.6.0 - (May 2, 2018)

  • Changed
    • Minor dependency version bump

1.5.0 - (April 20, 2018)

  • Changed
    • Minor dependency version bump

1.4.0 - (April 15, 2018)

  • Changed
    • Minor dependency version bump

1.3.0 - (April 5, 2018)

  • Changed
    • Minor dependency version bump

1.2.0 - (March 30, 2018)

  • Changed
    • Minor dependency version bump

1.1.0 - (March 14, 2018)

  • Changed
    • Exported AvatarVariants constants.

1.0.0 - (March 6, 2018)

  • Initial stable release