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(useMin): new function #1814

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all 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/math/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ export * from './logicOr'
export * from './useCeil'
export * from './useClamp'
export * from './useFloor'
export * from './useMinimum'
export * from './useProjection'
export * from './useRound'
33 changes: 33 additions & 0 deletions packages/math/useMinimum/demo.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<script setup lang="ts">
import { ref } from 'vue'
import { useMinimum } from '@vueuse/math'
const min1 = ref(10)
const min2 = ref(20)
const result = useMinimum(min1, min2)
</script>

<template>
<div>
<div>
min1:
<input v-model="min1" type="number">
<button @click="min1--">
min1 -= 1
</button>
<button @click="min1++">
min1 += 1
</button>
</div>
<div>
min2:
<input v-model="min2" type="number">
<button @click="min2--">
min2 -= 1
</button>
<button @click="min2++">
min2 += 1
</button>
</div>
result:{{ result }}
</div>
</template>
20 changes: 20 additions & 0 deletions packages/math/useMinimum/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
category: '@Math'
---

# useMinimum

Reactively get minimum of values.

## Usage

```ts
import { useMinimum } from '@vueuse/math'

const min1 = ref(10)
const min2 = ref(20)
const result = useMinimum(min1, min2)
// result.value is 10
min2.value = 5
// result.value is 5 now
```
44 changes: 44 additions & 0 deletions packages/math/useMinimum/index.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { ref } from 'vue-demi'
import { useMin, useMinimum } from '.'

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

it('should accept numbers', () => {
const v = useMinimum(0, 100)
expect(v.value).toBe(0)
})

it('should accept refs', () => {
const value1 = ref(10)
const value2 = ref(100)
const value3 = ref(1000)

const v = useMinimum(value1, value2, value3)
expect(v.value).toBe(10)

value1.value = 9
expect(v.value).toBe(9)

value2.value = 8
expect(v.value).toBe(8)

value3.value = 7
expect(v.value).toBe(7)
})

it('should accept numbers and refs', () => {
const value1 = 10
const value2 = ref(100)

const v = useMinimum(50, value1, value2)

expect(v.value).toBe(10)

value2.value = 9
expect(v.value).toBe(9)
})
})
18 changes: 18 additions & 0 deletions packages/math/useMinimum/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { computed } from 'vue-demi'
import type { MaybeComputedRef } from '@vueuse/shared'
import { resolveUnref } from '@vueuse/shared'

/**
* Reactively get minimum of values.
*
* @see https://vueuse.org/useMinimum
* @param values
*/
export function useMinimum(...mins: MaybeComputedRef<number>[]) {
return computed<number>(() =>
Math.min(...mins.map(value => resolveUnref(value))),
)
}

// alias
export { useMinimum as useMin }