diff --git a/components/vf-banner/CHANGELOG.md b/components/vf-banner/CHANGELOG.md index 308b429b87..6b62810cd8 100755 --- a/components/vf-banner/CHANGELOG.md +++ b/components/vf-banner/CHANGELOG.md @@ -1,3 +1,7 @@ +### 1.9.1 + +* `--inline` variant Nunjucks template file cleanup. + ### 1.9.0 * Correct "tertary" typo in "vf-button--tertiary". diff --git a/components/vf-banner/vf-banner--inline.njk b/components/vf-banner/vf-banner--inline.njk index 16ddc35af3..3b53c01fbf 100644 --- a/components/vf-banner/vf-banner--inline.njk +++ b/components/vf-banner/vf-banner--inline.njk @@ -1,5 +1,4 @@ - - +

This is a new web page. Complete our quick survey to help us make it better.

diff --git a/components/vf-box/CHANGELOG.md b/components/vf-box/CHANGELOG.md index 0128e6b42d..58e391563b 100755 --- a/components/vf-box/CHANGELOG.md +++ b/components/vf-box/CHANGELOG.md @@ -1,3 +1,7 @@ +### 2.4.0 + +* Deprecates `vf-box`. Most use cases should now use the `vf-card` component. A new layout-specific `vf-box` may be made in the future. + ### 2.3.3 * Repeat release of 2.3.2 for dependency linkage. diff --git a/components/vf-box/README.md b/components/vf-box/README.md index 6d73f6511f..cfa5def093 100755 --- a/components/vf-box/README.md +++ b/components/vf-box/README.md @@ -4,10 +4,12 @@ ## About -The `vf-box` layout container can add spacing, a background color, a border, and text colours to an area of content. +This component has been deprecated. Please use the vf-card component. A new layout-specific `vf-box` may be made in the future. ## Usage +The `vf-box` layout container can add spacing, a background color, a border, and text colours to an area of content. + A `vf-box` can be used in all layout components (`vf-grid`, `vf-stack`, `embl-grid`) and also inside of `vf-content`. For now `vf-box` is only designed to accept a heading and text (both have classes). The text node – `vf-box__text` can also accept a link which will inherit the text colour. diff --git a/components/vf-box/vf-box.config.yml b/components/vf-box/vf-box.config.yml index fcd31fb3f9..0e9bd10596 100755 --- a/components/vf-box/vf-box.config.yml +++ b/components/vf-box/vf-box.config.yml @@ -1,8 +1,10 @@ title: Box label: Box -status: live +status: deprecated +component-type: deprecated +hidden: true context: - component-type: block + component-type: deprecated variants: - name: default hidden: true @@ -109,21 +111,21 @@ variants: box_text: This is some more content that would be in the box. variant: normal theme: primary - box_spacing: 400 + box_spacing: 400 - name: "600" context: box_heading: Did you know? box_text: This is some more content that would be in the box. variant: normal theme: primary - box_spacing: 600 + box_spacing: 600 - name: "800" context: box_heading: Did you know? box_text: This is some more content that would be in the box. variant: normal theme: primary - box_spacing: 800 + box_spacing: 800 - name: easy primary is a link context: box_href: "JavaScript:Void(0);" diff --git a/tools/vf-component-library/src/site/guidance/deprecating-components.njk b/tools/vf-component-library/src/site/guidance/deprecating-components.njk index 40303106f8..df6b76c507 100644 --- a/tools/vf-component-library/src/site/guidance/deprecating-components.njk +++ b/tools/vf-component-library/src/site/guidance/deprecating-components.njk @@ -30,9 +30,9 @@ Here's what we need to make sure we do: 1. Update `README.md` with: - why the component has been deprecated - what component(s) developers should instead use - - Use this template + - Use this template in the README.md file ```html - This component has been deprecated. Please use the component. in the README.md file. + This component has been deprecated. Please use the new component. ``` 1. Publish on npm - see [`PUBLISHING.md`](https://github.com/visual-framework/vf-core/blob/develop/PUBLISHING.md) @@ -45,7 +45,7 @@ Here's what we need to make sure we do: 1. Add a note to the `--variant.njk` - Use this template ```html -

This variant has been deprecated. Please use the component.

in the README.md file. + This variant has been deprecated. Please use the new component. ``` 1. Wrap the relevant Sass in `html:not(.vf-disable-deprecated) {` 1. Hide the variant tab in `.config.yml`: