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

feat(useParentElement): new function #2855

Merged
merged 5 commits into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/core/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export * from './useOffsetPagination'
export * from './useOnline'
export * from './usePageLeave'
export * from './useParallax'
export * from './useParentElement'
export * from './usePerformanceObserver'
export * from './usePermission'
export * from './usePointer'
Expand Down
9 changes: 9 additions & 0 deletions packages/core/useParentElement/Demo.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script lang="ts" setup>
import { useParentElement } from '@vueuse/core'

const { parentElement } = useParentElement()
</script>

<template>
<p>Parent element tag: {{ parentElement ? parentElement.tagName : 'Finding...' }}</p>
</template>
30 changes: 30 additions & 0 deletions packages/core/useParentElement/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
category: Elements
---

# useParentElement

Get parent element of the given element

## Usage

```js
import { useParentElement } from '@vueuse/core'

const { parentEl } = useParentElement()

console.log('parentEl :>>', parentEl.value)
```

It can also accept a `ref` as the first argument.

```js
import { useParentElement } from '@vueuse/core'

// Don't forget to bind the ref to the element
const tooltip = ref()

const { parentEl: tooltipWrapper } = useParentElement(tooltip)

console.log('tooltipWrapper :>>', tooltipWrapper.value)
```
24 changes: 24 additions & 0 deletions packages/core/useParentElement/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { defineComponent, h, ref } from 'vue-demi'
import { mount } from '../../.test'
import { useParentElement } from '.'

describe('useParentElement', () => {
it('should be defined', () => {
expect(useParentElement).toBeDefined()
})

it('should accept ref', () => {
const liEl = ref()
const vm = mount(defineComponent({
setup() {
return () => h('ul', {}, [
h('li', { ref: liEl }),
])
},
}))

const { parentElement } = useParentElement(liEl)

expect(parentElement.value.tagName).to.equal('UL')
})
})
18 changes: 18 additions & 0 deletions packages/core/useParentElement/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import type { MaybeComputedRef } from '@vueuse/shared'
import { resolveUnref, tryOnMounted } from '@vueuse/shared'
import { getCurrentInstance, ref } from 'vue-demi'
import { unrefElement } from '../unrefElement'

export const useParentElement = (element?: MaybeComputedRef<HTMLElement | SVGElement | null | undefined>) => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use function on top-level

const parentElement = ref()

tryOnMounted(() => {
const el = unrefElement(resolveUnref(element) || getCurrentInstance()?.proxy)
if (el)
parentElement.value = el.parentElement
})

return {
parentElement,
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
return {
parentElement,
}
return parentElement

Do you foresee any other things to return in the future?

}