Skip to content

refactor(core): composedrefs name change #261

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

Merged
productdevbook merged 1 commit into from
Aug 2, 2023
Merged

refactor(core): composedrefs name change #261

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/components/checkbox/src/checkbox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { PropType, Ref } from 'vue'
import { computed, defineComponent, h, ref, toRefs, watchEffect } from 'vue'

import { composeEventHandlers } from '@oku-ui/utils'
import { useComposeRefs, useControllable, useForwardRef } from '@oku-ui/use-composable'
import { useComposedRefs, useControllable, useForwardRef } from '@oku-ui/use-composable'
import { Primitive } from '@oku-ui/primitive'

import type { ComponentPublicInstanceRef, ElementType, InstanceTypeRef, MergeProps, PrimitiveProps } from '@oku-ui/primitive'
Expand Down Expand Up @@ -73,7 +73,7 @@ const Checkbox = defineComponent({

const buttonRef = ref<ComponentPublicInstanceRef<HTMLButtonElement> | null>(null)
const forwardedRef = useForwardRef()
const composedRefs = useComposeRefs(buttonRef, forwardedRef)
const composedRefs = useComposedRefs(buttonRef, forwardedRef)

const {
name,
Expand Down
4 changes: 2 additions & 2 deletions packages/components/collapsible/src/collapsibleContentImpl.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { ComponentPublicInstanceRef, ElementType, InstanceTypeRef, MergePro
import type { Scope } from '@oku-ui/provide'
import { Primitive } from '@oku-ui/primitive'

import { useComposeRefs, useForwardRef } from '@oku-ui/use-composable'
import { useComposedRefs, useForwardRef } from '@oku-ui/use-composable'
import { useCollapsibleInject } from './collapsible'
import { getState } from './utils'
import { CONTENT_NAME } from './collapsibleContent'
Expand Down Expand Up @@ -36,7 +36,7 @@ const CollapsibleContentImpl = defineComponent({

const _ref = ref<ComponentPublicInstanceRef<HTMLDivElement> | undefined>(undefined)
const forwardedRef = useForwardRef()
const composedRefs = useComposeRefs(_ref, forwardedRef)
const composedRefs = useComposedRefs(_ref, forwardedRef)

const heightRef = ref<number | undefined>(0)
const widthRef = ref<number | undefined>(0)
Expand Down
4 changes: 2 additions & 2 deletions packages/components/popper/src/popperAnchor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import type {
import type { Measurable } from '@oku-ui/utils'
import type { Scope } from '@oku-ui/provide'
import { Primitive } from '@oku-ui/primitive'
import { useComposeRefs, useForwardRef } from '@oku-ui/use-composable'
import { useComposedRefs, useForwardRef } from '@oku-ui/use-composable'
import { usePopperInject } from './popper'

/* -------------------------------------------------------------------------------------------------
Expand Down Expand Up @@ -53,7 +53,7 @@ const PopperAnchor = defineComponent({
const inject = usePopperInject(ANCHOR_NAME, scopeCheckbox.value)

const _ref = ref<ComponentPublicInstanceRef<HTMLDivElement> | null>(null)
const composedRefs = useComposeRefs(_ref, useForwardRef())
const composedRefs = useComposedRefs(_ref, useForwardRef())

watch(_ref, () => {
inject.value.anchor.value
Expand Down
4 changes: 2 additions & 2 deletions packages/components/popper/src/popperContent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { computed, defineComponent, h, onMounted, ref, toRefs, watch, watchEffec
import { Primitive } from '@oku-ui/primitive'
import type { ComponentPublicInstanceRef, ElementType, InstanceTypeRef, MergeProps, PrimitiveProps } from '@oku-ui/primitive'
import type { Scope } from '@oku-ui/provide'
import { computedEager, useCallbackRef, useComposeRefs, useForwardRef, useSize } from '@oku-ui/use-composable'
import { computedEager, useCallbackRef, useComposedRefs, useForwardRef, useSize } from '@oku-ui/use-composable'
import { autoUpdate, flip, arrow as floatingUIarrow, hide, limitShift, offset, shift, size, useFloating } from '@floating-ui/vue'
import type {
DetectOverflowOptions,
Expand Down Expand Up @@ -148,7 +148,7 @@ const PopperContent = defineComponent({
const inject = usePopperInject(CONTENT_NAME, scopePopper.value)

const content = ref<ComponentPublicInstanceRef<HTMLDivElement> | null>(null)
const composedRefs = useComposeRefs(content, useForwardRef())
const composedRefs = useComposedRefs(content, useForwardRef())

const arrow = ref<HTMLSpanElement | null>(null)
const arrowSize = useSize(arrow)
Expand Down
4 changes: 2 additions & 2 deletions packages/components/slot/src/slot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { cloneVNode, createVNode, defineComponent, mergeProps } from 'vue'
import { useComposeRefs, useForwardRef } from '@oku-ui/use-composable'
import { useComposedRefs, useForwardRef } from '@oku-ui/use-composable'
import { isSlottable } from './utils'

const NAME = 'OkuSlot'
Expand All @@ -9,7 +9,7 @@ const OkuSlot = defineComponent({
inheritAttrs: false,
setup(props, { attrs, slots }) {
const forwarded = useForwardRef()
const composedRefs = useComposeRefs(forwarded)
const composedRefs = useComposedRefs(forwarded)

return () => {
const defaultSlot = slots.default?.()
Expand Down
4 changes: 2 additions & 2 deletions packages/components/switch/src/Switch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
toValue,
useModel,
} from 'vue'
import { useComposeRefs, useControllable, useForwardRef } from '@oku-ui/use-composable'
import { useComposedRefs, useControllable, useForwardRef } from '@oku-ui/use-composable'
import type {
ComponentPublicInstanceRef,
ElementType,
Expand Down Expand Up @@ -111,7 +111,7 @@ const Switch = defineComponent({

const buttonRef = ref<ComponentPublicInstanceRef<HTMLButtonElement> | null>(null)
const forwardedRef = useForwardRef()
const composedRefs = useComposeRefs(buttonRef, forwardedRef)
const composedRefs = useComposedRefs(buttonRef, forwardedRef)

const modelValue = useModel(props, 'modelValue')

Expand Down
2 changes: 1 addition & 1 deletion packages/core/use-composable/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export { useSize } from './useSize'
export { usePrevious } from './usePrevious'
export { unrefElement } from './unrefElement'
export { useId } from './useId'
export { useComposeRefs } from './useComposeRefs'
export { useComposedRefs } from './useComposedRefs'
export { useForwardRef } from './useForwardRef'
export { useEscapeKeydown } from './useEscapeKeydown'
export type { MaybeComputedElementRef } from './unrefElement'
Expand Down
2 changes: 1 addition & 1 deletion ...core/use-composable/src/useComposeRefs.ts → ...ore/use-composable/src/useComposedRefs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export type RefSetter = (
el: Element | ComponentPublicInstance | undefined
) => void

export function useComposeRefs(...refs: (Ref<HTMLElement | undefined | null | ComponentPublicInstance> | RefSetter)[]) {
export function useComposedRefs(...refs: (Ref<HTMLElement | undefined | null | ComponentPublicInstance> | RefSetter)[]) {
return (el: Element | ComponentPublicInstance | null) => {
refs.forEach((ref) => {
if (isFunction(ref))
Expand Down
6 changes: 3 additions & 3 deletions packages/core/use-composable/tests/useComposeRefs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { Component, DefineComponent } from 'vue'
import { h, onMounted, ref } from 'vue'
import { describe, expect, test } from 'vitest'
import { mount } from '@vue/test-utils'
import { useComposeRefs } from '../src/useComposeRefs'
import { useComposedRefs } from '../src/useComposedRefs'

const DivComponent: Component = {
name: 'Refs',
Expand All @@ -12,7 +12,7 @@ const DivComponent: Component = {
const ref2 = ref()
const ref3 = ref()

const refs = useComposeRefs(ref1, ref2, ref3)
const refs = useComposedRefs(ref1, ref2, ref3)
onMounted(() => {
expect(ref1.value).toBeInstanceOf(HTMLDivElement)
expect(ref2.value).toBeInstanceOf(HTMLDivElement)
Expand Down Expand Up @@ -43,7 +43,7 @@ describe('Provide', () => {
const ref1 = ref()
const ref2 = ref()
const ref3 = ref()
const refs = useComposeRefs(ref1, ref2, ref3)
const refs = useComposedRefs(ref1, ref2, ref3)
onMounted(() => {
expect(ref1.value).toBeInstanceOf(HTMLDivElement)
expect(ref2.value).toBeInstanceOf(HTMLDivElement)
Expand Down
6 changes: 3 additions & 3 deletions packages/core/use-composable/tests/useForwardRef.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { Component, DefineComponent } from 'vue'
import { h, onMounted, ref } from 'vue'
import { describe, expect, test } from 'vitest'
import { mount } from '@vue/test-utils'
import { useComposeRefs } from '../src/useComposeRefs'
import { useComposedRefs } from '../src/useComposedRefs'
import { useForwardRef } from '../src/useForwardRef'

const DivComponent: Component = {
Expand All @@ -13,7 +13,7 @@ const DivComponent: Component = {
const ref2 = ref()
const ref3 = ref()

const refs = useComposeRefs(ref1, ref2, ref3, useForwardRef())
const refs = useComposedRefs(ref1, ref2, ref3, useForwardRef())
onMounted(() => {
expect(ref1.value).toBeInstanceOf(HTMLDivElement)
expect(ref2.value).toBeInstanceOf(HTMLDivElement)
Expand Down Expand Up @@ -44,7 +44,7 @@ describe('Provide', () => {
const ref1 = ref()
const ref2 = ref()
const ref3 = ref()
const refs = useComposeRefs(ref1, ref2, ref3)
const refs = useComposedRefs(ref1, ref2, ref3)
onMounted(() => {
expect(ref1.value).toBeInstanceOf(HTMLDivElement)
expect(ref2.value).toBeInstanceOf(HTMLDivElement)
Expand Down