Skip to content

Commit

Permalink
doc: add LoginImage doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pirhoo committed Aug 14, 2024
1 parent 6ed6802 commit bb1e303
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
24 changes: 24 additions & 0 deletions src/stories/components/Login/LoginImage.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { Canvas, Meta } from '@storybook/blocks'

import * as LoginImage from './LoginImage.stories'

<Meta of={LoginImage} />

# LoginImage

The `LoginImage` is providing an image for the login page. The image is already configured to offer a variant
in dark mode. The component expose a `shake` function that triggers a shaking animation on the Datashare logo
inside the image.

For instance:

```html
<div class="text-center">
<login-image ref="image" class="my-5" />
<button-icon label="Shake it!" icon-left="disco-ball" icon-left-weight="fill" @click="image.shake()" />
</div>
```

Will result to:

<Canvas of={LoginImage.Default} sourceState='none' />
1 change: 0 additions & 1 deletion src/stories/components/Login/LoginImage.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import LoginImage from '@/components/Login/LoginImage'

export default {
title: 'Components/Login/LoginImage',
tags: ['autodocs'],
component: LoginImage,
render: () => ({
components: {
Expand Down

0 comments on commit bb1e303

Please sign in to comment.