Skip to main content

ns-illustration

Introduction#

Illustrations are visual symbols used to bring the warmth of British Gas brand and personality to the website.

Illustrations simplify products and services to users in a friendly manner. Illustrations always accompany content.

Best practice#

๐Ÿ’š Do's๐Ÿ’” Don'ts
Use them to convey depthMake the illustrations small
Use on their own as the primary visual element

Considerations of best practices#

  • List of when to use which illustration (need to talk to Will about it).

Usage#

View example on Storybook

Component placement#

The ns-illustration component can be used in a number of components to help create bespoke UIs.

Specification#

AttributeTypeDefaultOptionsDescription
typestringgasappliance, boiler, boilerRepair, bulb, centralHeating, clock, dualFuel, electrics, electricVehicle, engineer, gas, help, home, oven, pipeAndDrain, protect, tap, savings, yellowShield See Illustration component in StorybookPicks the illustration that is to be shown.
sizenumber'''', 1, 2, 3, 4, 5Changes the size of the illustration, with 1 being the smallest.
inactivestringfalsetrue, falseWill grey out the illustration.

Specification notes#

Size#

  • If you pass an empty size the icon will fill the parent element

Inactive#

  • This is for decorative purposes only (does not work in IE11).

Creating new illustrations#

If you are looking to create a new illustration then please check there is not something similar already in use. If there is no suitable illustration then you should let us know and we can look at creating it for the design system.

Read our illustration foundation page for more information on creating illustrations.

Feedback#

  • Do you have insights or concerns to share? You can raise an issue via Github bugs.
  • See all the issues already raised via Github issues.

๐Ÿ’ฉ ๐ŸŽ‰ ๐Ÿฆ„ You can also contact the team on Slack on the #product-nucleus channel!

Related links#