Skip to content

Commit

Permalink
Issue-2114: Enhancements for vf-blockquote
Browse files Browse the repository at this point in the history
  • Loading branch information
bhushan-ebi committed Oct 30, 2024
1 parent 8f9e0ed commit 6859e85
Show file tree
Hide file tree
Showing 21 changed files with 289 additions and 271 deletions.
4 changes: 4 additions & 0 deletions components/vf-blockquote/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 1.2.8

* Small variant added, documentation updated, responsive support added [Tracking issue](https://github.com/visual-framework/vf-core/issues/2114)

### 1.2.7

* Dependency update [Tracking issue](https://github.com/visual-framework/vf-core/issues/1647)
Expand Down
7 changes: 6 additions & 1 deletion components/vf-blockquote/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The `vf-blockquote` highlights a section that is quoted from an external source.

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

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

Expand All @@ -29,6 +29,11 @@ The blockquote is designed to be used on a white background, it is advisable to
- 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.

### Size

When using vf-blockquote with headings that have smaller font sizes such as 24 px, it is recommended to use the small-vf-blockquote variant as the default blockquote variant has a font size of 28px and could compete with smaller heading sizes for attention.
When showing multiple quotes in a section, such as testimonials or multiple endorsements the small variant is recommended.

### Accessibility

- This component targets WCAG 2.1 AA accessibility.
Expand Down
2 changes: 2 additions & 0 deletions components/vf-blockquote/vf-blockquote.angular/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Nested package.json's are only needed for development.
**/package.json

This file was deleted.

Loading

0 comments on commit 6859e85

Please sign in to comment.