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.

Sign up for GitHub

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

Jump to bottom

fix(useElementVisibility)!: rename type VisibilityScrollTargetOptions to UseElementVisibilityOptions #1863

Merged
merged 1 commit into from Jul 12, 2022
Merged

fix(useElementVisibility)!: rename type VisibilityScrollTargetOptions to UseElementVisibilityOptions #1863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions packages/core/useElementVisibility/directive.test.ts
View file
Open in desktop
Expand Up @@ -3,7 +3,7 @@ import type { VueWrapper } from '@vue/test-utils'
import { mount } from '@vue/test-utils'

import { vElementVisibility } from './directive'
import type { VisibilityScrollTargetOptions } from '.'
import type { UseElementVisibilityOptions } from '.'

const App = defineComponent({
props: {
Expand Down Expand Up @@ -51,7 +51,7 @@ describe('vElementVisibility', () => {
describe('given options', () => {
beforeEach(() => {
onVisibility = vi.fn()
const options: VisibilityScrollTargetOptions = {
const options: UseElementVisibilityOptions = {
scrollTarget: document.body,
}
wrapper = mount(App, {
Expand Down
4 changes: 2 additions & 2 deletions packages/core/useElementVisibility/directive.ts
View file
Open in desktop
Expand Up @@ -2,12 +2,12 @@ import { watch } from 'vue-demi'
import { directiveHooks } from '@vueuse/shared'
import type { ObjectDirective } from 'vue-demi'

import type { VisibilityScrollTargetOptions } from '.'
import type { UseElementVisibilityOptions } from '.'
import { useElementVisibility } from '.'

type BindingValueFunction = (state: boolean) => void

type BindingValueArray = [BindingValueFunction, VisibilityScrollTargetOptions]
type BindingValueArray = [BindingValueFunction, UseElementVisibilityOptions]

export const vElementVisibility: ObjectDirective<
HTMLElement,
Expand Down
4 changes: 2 additions & 2 deletions packages/core/useElementVisibility/index.ts
View file
Open in desktop
Expand Up @@ -6,7 +6,7 @@ import { useEventListener } from '../useEventListener'
import type { ConfigurableWindow } from '../_configurable'
import { defaultWindow } from '../_configurable'

export interface VisibilityScrollTargetOptions extends ConfigurableWindow {
export interface UseElementVisibilityOptions extends ConfigurableWindow {
scrollTarget?: MaybeComputedRef<HTMLElement | undefined | null>
}

Expand All @@ -19,7 +19,7 @@ export interface VisibilityScrollTargetOptions extends ConfigurableWindow {
*/
export function useElementVisibility(
element: MaybeComputedElementRef,
{ window = defaultWindow, scrollTarget }: VisibilityScrollTargetOptions = {},
{ window = defaultWindow, scrollTarget }: UseElementVisibilityOptions = {},
) {
const elementIsVisible = ref(false)

Expand Down