Skip to content

Commit

Permalink
Revert "Issue 1957: Updated the documentation for blockquote (#1961)" (
Browse files Browse the repository at this point in the history
…#1962)

This reverts commit 4d5dd6d.
  • Loading branch information
sandykadam committed Sep 28, 2023
1 parent 4d5dd6d commit 9b33ded
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 31 deletions.
5 changes: 0 additions & 5 deletions components/vf-blockquote/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
### 1.2.1

* Updated the documentation for blockquote as per new implementation
* [Tracking issue](https://github.com/visual-framework/vf-core/issues/1957)

### 1.2.0

* adds context `if` statement to make it useable in vf-11ty.
Expand Down
28 changes: 2 additions & 26 deletions components/vf-blockquote/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,11 @@

## About

The `vf-blockquote` highlights a section that is quoted from an external source.
A way to quote and highlight text.

## Usage

The `vf-blockquote` should be used to highlight texts from external sources like quotes and testimonials. It should be used for more than decorative purposes, ensuring that the text being quoted is relevant to the content of the page and adds value to the content. This component is not optimised for mobile devices.

It should not be confused with a pull quote which highlights a section of text from the same source/page.

Quotes should be as concise as possible. The impact of the blockquote is diminished when it has long texts as this overwhelms the reader.

Provide proper attribution such as the name, source and relevant information to give credibility to the quote. The component allows you to add the image of the person, the name (Which can be linked to a profile or source page) and other attribution details.

The blockquote is designed to be used on a white background, it is advisable to avoid using it on backgrounds with gradients, images or other colours. If the background colour is changed, ensure the contrast ratio between the texts and the background meet accessibility standards.


### When to use

- Quoting external sources such as individuals, experts, publications etc.
- Testimonials and feedback can be highlighted using the `vf-blockquote`.

### When not to use

- Self-quoting or usage as a pull quote should be avoided in the context of the page/content. This component should not be used to highlight a portion of text from the same content.
- `Vf-blockquotes` should not be used solely for decorative purposes, ensuring that the quoted text adds value to the content.

### Accessibility

- This component targets WCAG 2.1 AA accessibility.

The pullquote variant will be a decorative variation but has yet to be implemented, it may take inspiration from the [VF 1.3 pullquote](https://www.ebi.ac.uk/style-lab/websites/patterns/pullquotes.html).

## Install

Expand Down

0 comments on commit 9b33ded

Please sign in to comment.