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

Collapse Component #46

Merged
merged 3 commits into from
Jul 16, 2023
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
19 changes: 19 additions & 0 deletions components/content/examples/collapse/HeightCollapse.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<template>
<CBox>
<CButton mb="4" variant-color="blue" @click="show = !show">
Show {{ show ? 'Less' : 'More' }}
</CButton>
<CCollapse :is-open="show" :starting-height="20">
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a
type specimen book.
</CCollapse>
</CBox>
</template>


<script setup>
import { ref } from 'vue';

const show = ref(false);
</script>
18 changes: 18 additions & 0 deletions components/content/examples/collapse/SimpleCollapse.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<template>
<CBox>
<CButton mb="4" variant-color="blue" @click="show = !show">
Toggle
</CButton>
<CCollapse :is-open="show">
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a
type specimen book.
</CCollapse>
</CBox>
</template>

<script setup>
import { ref } from 'vue';

const show = ref(false);
</script>
42 changes: 37 additions & 5 deletions components/content/prose/ProseA.vue
Original file line number Diff line number Diff line change
@@ -1,14 +1,46 @@
<template>
<NuxtLink prefetch>
<slot />
</NuxtLink>
</template>
<script setup>
const props = defineProps({
href: {
type: String,
default: ''
},
blank: {
type: Boolean,
default: false
}
})
function isHttpUrl(string) {
let url;
try {
url = new URL(string);
} catch (_) {
return false;
}
return url.protocol === "http:" || url.protocol === "https:";
}
const isExternal = isHttpUrl(props.href)
let bindProps = {
to: props.href
}
if (isExternal || props.blank) {
bindProps.target = '_blank'
}
</script>

<style scoped>
a {
color: var(--chakra-colors-green-600);
}

a:hover {
text-decoration: underline;
}
</style>


<template>
<NuxtLink v-bind="bindProps">
<slot />
</NuxtLink>
</template>

76 changes: 76 additions & 0 deletions content/4.components/collapse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: Collapse
description: Collapse component
version: 2.0+
---
# Collapse

The Collapse component is used to create regions of content that can expand/collapse with a basic animation. It helps to hide content that's not immediately relevant to the user.

This component leverages [animejs](https://animejs.com/){target="_blank"}, and composes the Box component.

## Import

```js
import { CCollapse } from "@chakra-ui/vue-next";
```

## Usage

::showcase
:simple-collapse{width=full}
::


```html
<CBox>
<CButton mb="4" variant-color="blue" @click="show = !show">
Toggle
</CButton>
<CCollapse :is-open="show">
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a
type specimen book.
</CCollapse>
</CBox>
```

## Change the Starting Height

::showcase
:height-collapse{width=full}
::


```html
<CBox>
<CButton mb="4" variant-color="blue" @click="show = !show">
Show {{ show ? 'Less' : 'More' }}
</CButton>
<CCollapse :is-open="show" :starting-height="20">
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's
standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a
type specimen book.
</CCollapse>
</CBox>
```

## Props

This component doesn't have any custom props.

| Name | Type | Description |
|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| isOpen | `boolean` | If `true`, the content will be visible |
| animateOpacity | `boolean` | If `true`, the opacity of the content will be animated |
| duration | `number` | The animation duration as it expands |
| startingHeight | `number` | he height you want the content in it's collapsed state. Set to `0` by default |
| endingHeight | `number` | The height you want the content in it's expanded state. Set to `auto` by default |
| easing | `string` | Add easing function for entering and leaving state. Accepts easing props from [animejs](https://animejs.com/documentation/#linearEasing){target="_blank"}. Set to `easeInOutSine` by default. |

## Events

| Name | Payload | Description |
|----------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------|
| `@start` | `Event` | The event to be called when the collapse animation starts. |
| `@finish` | `Event` | The event to be called when the collapse animation ends. |