Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for <Motion> component #192

Merged
merged 3 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions docs/components/content/examples/MotionComponent.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<script lang="ts" setup></script>

<template>
<div class="example-wrapper">
<div class="example-hint">Scroll down to trigger motion!</div>
<Motion is="p" preset="slideVisibleLeft">
<div class="example-target">Text in Motion!</div>
</Motion>
</div>
</template>

<style scoped>
.example-wrapper {
height: 200px;
width: 100%;
overflow-y: scroll;
overflow-x: hidden;
text-align: center;
border: 1px solid #222;
border-radius: 0.5em;
}

.example-hint,
p {
display: flex;
flex: 1 0;

align-items: center;
justify-content: center;

height: 100%;
padding: 2em;
}

.example-target {
padding: 1em;
background-color: #111;
border-radius: 0.5em;
}
</style>
58 changes: 58 additions & 0 deletions docs/components/content/examples/MotionGroupComponent.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
<script lang="ts" setup></script>

<template>
<div class="example-wrapper">
<div class="example-hint">Scroll down to trigger motion!</div>
<MotionGroup preset="slideVisibleLeft" :duration="600">
<section>
<h3>Product 1</h3>
<p>Description text</p>
</section>
<section>
<h3>Product 2</h3>
<p>Description text</p>
</section>
<section>
<h3>Product 3</h3>
<p>Description text</p>
</section>
</MotionGroup>
</div>
</template>

<style scoped>
.example-wrapper {
height: 200px;
width: 100%;
overflow-y: scroll;
overflow-x: hidden;
text-align: center;
border: 1px solid #222;
border-radius: 0.5em;
}

.example-hint,
p,
section {
display: flex;
flex-direction: column;

flex: 1 0;
align-items: center;
justify-content: center;

height: 100%;
padding: 2em;
}

section {
background-color: #111;
height: calc(100% / 3);
}

section h3,
section p {
margin: 0.5em !important;
padding: 0 !important;
}
</style>
91 changes: 91 additions & 0 deletions docs/content/2.features/7.components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Components

vueuse/motion allows you to implement your animations directly within the template of your components without the need to wrap target elements in any additional components.

These components work similar to the directive `v-motion` usage but work better in projects using server-side rendering.

## `<Motion>`

Example of a `<Motion>` component using a motion preset on a `<p>` element:

```vue
<template>
<Motion is="p" preset="slideVisibleLeft">Text in Motion!</Motion>
</template>
```

<MotionComponent></MotionComponent>

## `<MotionGroup>`

The `<MotionGroup>` can be used to apply motion configuration to all of its child elements, this component is renderless by default and can be used as a wrapper by passing a value to the `:is` prop.

```vue
<template>
<MotionGroup preset="slideVisibleLeft" :duration="600">
<section>
<h3>Product 1</h3>
<p>Description text</p>
</section>
<section>
<h3>Product 2</h3>
<p>Description text</p>
</section>
<section>
<h3>Product 3</h3>
<p>Description text</p>
</section>
</MotionGroup>
</template>
```

<MotionGroupComponent></MotionGroupComponent>


## Props

The `<Motion>` and `<MotionGroup>` components allow you to define animation properties (variants) as props.

- **`is`**: What element should rendered (`div` by default for `<Motion>`).
- **`preset`**: Motion preset to use (expects camel-case string), see [Presets](/features/presets).

### Variant props

- **`initial`**: Properties the element will have before it is mounted.
- **`enter`**: Properties the element will have after it is mounted.
- **`visible`**: Properties the element will have whenever it is within view. Once out of view, the `initial` properties are reapplied.
- **`visible-once`**: Properties the element will have once it enters the view.
- **`hovered`**: Properties the element will have when hovered.
- **`focused`**: Properties the element will have when it receives focus.
- **`tapped`**: Properties the element will have upon being clicked or tapped.

Variants can be passed as an object using the `:variants` prop.

The `:variants` prop combines with other variant properties, allowing for the definition of custom variants from this object.

Additional variant properties can be explored on the [Variants](/features/variants) page.

### Shorthand Props

We support shorthand props for quickly setting transition properties:

- **`delay`**
- **`duration`**

These properties apply to `visible`, `visible-once`, or `enter` variants if specified; otherwise, they default to the `initial` variant.

```vue
<template>
<Motion
:initial="{ opacity: 0, y: 100 }"
:enter="{ opacity: 1, y: 0, scale: 1 }"
:variants="{ custom: { scale: 2 } }"
:hovered="{ scale: 1.2 }"
:delay="200"
:duration="1200"
>
Content to animate!
</Motion>
</template>
```

3 changes: 3 additions & 0 deletions docs/nuxt.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ export default defineNuxtConfig({
'@vueuse/motion/nuxt': resolve(__dirname, '../src/nuxt/module.ts'),
},
modules: ['@vueuse/motion/nuxt'],
features: {
devLogs: false,
},
typescript: {
includeWorkspace: true,
},
Expand Down
Loading