Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changed : Issue-1920 - Retired explainer component #2040

Merged
merged 2 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions components/vf-componenet-rollup/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 1.4.8

* Deprecated `vf-collapse` component. [Tracking issue](https://github.com/visual-framework/vf-core/issues/1911)
* Deprecated `vf-explainer` component. [Tracking issue](https://github.com/visual-framework/vf-core/issues/1920)

## 1.4.7

* Fixed build notices. [Tracking issue](https://github.com/visual-framework/vf-core/issues/1936)
Expand Down
2 changes: 0 additions & 2 deletions components/vf-componenet-rollup/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,10 @@ button {

@import 'vf-badge/vf-badge.scss';
@import 'vf-bookmark/vf-bookmark.scss';
@import 'vf-collapse/vf-collapse.scss';
@import 'vf-link/vf-link.scss';
@import 'vf-logo/vf-logo.scss';
@import 'vf-embed/vf-embed.scss';
@import 'embl-logo/embl-logo.scss';
@import 'vf-explainer/vf-explainer.scss';
@import 'vf-form/vf-form.scss';
@import 'vf-button/vf-button.scss';
@import 'vf-figure/vf-figure.scss';
Expand Down
4 changes: 4 additions & 0 deletions components/vf-explainer/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 0.1.1

* Deprecated `vf-explainer` component. `vf-details` component needs to be used instead. [Tracking issue](https://github.com/visual-framework/vf-core/issues/1920)

### 0.1.0

* initial version
3 changes: 2 additions & 1 deletion components/vf-explainer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

## About

Life science websites love a bit of jargon and complicated concepts and "explainers" help for terms like: `ORCID`, `transcript isoform`, and `lymphoblastoid cell lines`.
This component has been <span class="vf-u-text-color--red">deprecated</span>. Please use the <a class="vf-link" href="https://stable.visual-framework.dev/components/vf-details">vf-details</a> component.
Justification text: This component hasn't been implemented. The basic use case for providing details is supported by vf-details. For highlighting explanations we suggested that the Comms team uses vf-card.

## Usage

Expand Down
6 changes: 4 additions & 2 deletions components/vf-explainer/vf-explainer.config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
title: Explainer
# Label shown on index pages
label: Explainer
status: alpha
status: deprecated
component-type: deprecated
hidden: true
# The template used from /components/_previews
#
# Per-variant options
# variants:
# - name: default
# hidden: true
context:
component-type: element
component-type: deprecated
# custom-values: passed as {{custom-values}}
# title: Title text
# text: String of text
Expand Down
9 changes: 5 additions & 4 deletions components/vf-explainer/vf-explainer.scss
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@
*/

@import 'vf-explainer.variables.scss';

.vf-explainer:before {
content: 'This component has not yet been implement, see the README.md for more information.';
display: block;
html:not(.vf-disable-deprecated) {
.vf-explainer:before {
content: 'This component has not yet been implement, see the README.md for more information.';
display: block;
}
}
Loading