Overview
KLogo
displays the Kolibri logo and provides functionality to manipulate it
such as setting its dimensions, color scheme, animation, and background.
Usage
Default display
Shows Kolibri logo.
<KLogo
altText="Kolibri logo"
:size="150"
/>
Display with backgrounds
Shows Kolibri logo with background.
<KLogo
altText="Kolibri Logo with background"
:showBackground="true"
:size="150"
/>
Shows Kolibri logo with rectangular background.
<KLogo
altText="Kolibri Logo with rectangular background"
backgroundStyle="rect"
:showBackground="true"
:size="150"
/>
Display with animation
Shows Kolibri logo with loading animation.
<KLogo
altText="Kolibri Logo with loading animation"
:animate="true"
:size="150"
/>
Display with different color schemes
Different color schemes can be used - but only with the showBackground prop. Note the transparent lines for the monochrome logos.
Color scheme: monoBlack
Color scheme: monoWhite
Color scheme: monoPrimary
Color scheme: monoSecondary
Color scheme: whiteGrey
Color scheme: blackGrey
Dimensions
You can apply the most common dimensions to the image container via the props
size
,
maxSize
, and
minSize
. Values may be either numbers or strings consisting of a numeral and a valid unit. The
following units are supported:
%, cm, em, ex, ch, in, lh, mm, px, rem, rlh, vh, vw
. If you don't provide a
unit, px
will be used by default.
<KLogo
altText="A hummingbird logo"
size="250px"
maxSize="10vw"
:minSize="25"
/>
Alternative text
Alternative text (altText
) is required for the logo image. When creating it,
consider the following:
- If the logo is used as a flat image, you can use the string "Kolibri logo"
- If the the logo is used as a link, then the alternative text needs to give the context where the link is leading (for example "Go to home page", or similar)
Props
Name | Description | Type | Default | Required |
---|---|---|---|---|
altText | Alternative text for the logo | string |
''
| true |
size | Sets the size for the logo | number|string |
undefined
| — |
maxSize | Sets the maximum size for the logo | number|string |
undefined
| — |
minSize | Sets the minimum size for the logo | number|string |
undefined
| — |
showBackground | Whether to show the blob background for the logo | boolean |
false
| — |
backgroundStyle | The background style for the logo: blob, rect | string |
'blob'
| — |
colorScheme | The color scheme for the logo:
default, monoBlack, monoWhite, monoPrimary, monoSecondary, whiteGrey, blackGrey | string |
'default'
| — |
animate | Whether to show the loading animation for the logo - only works for non-mono colorSchemes | boolean |
false
| — |