Skip to content

Commit

Permalink
Documentation : Issue 1910 - Updated documentation for vf-logo (#2112)
Browse files Browse the repository at this point in the history
  • Loading branch information
bhushan-ebi authored Sep 2, 2024
1 parent 1196f03 commit bdebcd3
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions components/vf-logo/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### 1.5.2

* Documentation : Updated documentation for vf-logo. [Tracking issue](https://github.com/visual-framework/vf-core/issues/1910)

### 1.5.1

* Makes logo larger only when using extreme variant.
Expand Down
12 changes: 12 additions & 0 deletions components/vf-logo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@

A simple component to add the Visual Framework logo to a page. You'll likely want to use this one as a template to add your own logo.

## Usage

This component allows you to add the vf-logo on your page. It can also serve as a template to add your own logo if it has a similar layout and design to the vf-logo. Before using it, ensure that your logo usage guidance and design layout do not conflict with the component.

Considering that texts in logo’s are classified as [essential](https://www.w3.org/WAI/WCAG21/Understanding/images-of-text#dfn-essential), there are [no contrast requirements](https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum.html) for adding a logo. However, where possible, make sure the logo is clearly visible against the background colour.

### Useful links

* [Design resources - EMBL](https://www.embl.org/internal-information/communications/design-resources/#vf-tabs__section-logos)
* [Contrast (Minimum) (Level AA) - WCAG 2.1 Understanding Docs](https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum.html)
* [Images of Text (Level AA) - WCAG 2.1 Understanding Docs](https://www.w3.org/WAI/WCAG21/Understanding/images-of-text#dfn-essential)

## Install

This component is distributed with npm. After [installing npm](https://www.npmjs.com/get-npm), you can install the `vf-logo` with this command.
Expand Down

0 comments on commit bdebcd3

Please sign in to comment.