8000 feat: useToggle by Shinigami92 · Pull Request #55 · un-ts/unuse · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat: useToggle #55

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
merged 1 commit into from
Jun 30, 2025
Merged

feat: useToggle #55

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
9 changes: 9 additions & 0 deletions .changeset/fluffy-nights-try.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
'unuse': minor
'unuse-angular': minor
'unuse-react': minor
'unuse-solid': minor
'unuse-vue': minor
---

feat: useToggle
1 change: 1 addition & 0 deletions packages/unuse/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,5 @@ export * from './unRefElement';
export * from './unResolve';
export * from './useEventListener';
export * from './useIntervalFn';
export * from './useToggle';
export * from './useWebSocket';
126 changes: 126 additions & 0 deletions packages/unuse/src/useToggle/index.angular.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
// @vitest-environment happy-dom

import type { WritableSignal } from '@angular/core';
import { isSignal, signal } from '@angular/core';
import { getTestBed } from '@angular/core/testing';
import {
BrowserTestingModule,
platformBrowserTesting,
} from '@angular/platform-browser/testing';
import { beforeAll, expect, it } from 'vitest';
import { describeAngular, ZonelessTestModule } from '../_testUtils/angular';
import type { ToggleFn } from './index';
import { useToggle } from './index';

describeAngular('useToggle', () => {
beforeAll(() => {
getTestBed().initTestEnvironment(
[BrowserTestingModule, ZonelessTestModule],
platformBrowserTesting()
);
});

it('default result', () => {
const result = useToggle() as unknown as [
WritableSignal<boolean>,
ToggleFn,
];
const [value, toggle] = result;

expect(Array.isArray(result)).toBe(true);
expect(result).toHaveLength(2);

expect(toggle).toBeTypeOf('function');
expect(value).toSatisfy(isSignal);
expect(value()).toBe(false);
});

it('default result with initialValue', () => {
const result = useToggle(true) as unknown as [
WritableSignal<boolean>,
ToggleFn,
];
const [value, toggle] = result;

expect(Array.isArray(result)).toBe(true);
expect(result).toHaveLength(2);

expect(toggle).toBeTypeOf('function');
expect(value).toSatisfy(isSignal);
expect(value()).toBe(true);
});

it('should toggle', () => {
const result = useToggle() as unknown as [
WritableSignal<boolean>,
ToggleFn,
];
const [value, toggle] = result;

expect(toggle()).toBe(true);
expect(value()).toBe(true);

expect(toggle()).toBe(false);
expect(value()).toBe(false);
});

it('should receive toggle param', () => {
const result = useToggle() as unknown as [
WritableSignal<boolean>,
ToggleFn,
];
const [value, toggle] = result;

expect(toggle(false)).toBe(false);
expect(value()).toBe(false);

expect(toggle(true)).toBe(true);
expect(value()).toBe(true);
});

it('signal initialValue', () => {
getTestBed().runInInjectionContext(() => {
const isDark = signal(true);
const toggle = useToggle(isDark);

expect(toggle).toBeTypeOf('function');

expect(toggle()).toBe(false);
expect(isDark()).toBe(false);

expect(toggle()).toBe(true);
expect(isDark()).toBe(true);

expect(toggle(false)).toBe(false);
expect(isDark()).toBe(false);

expect(toggle(true)).toBe(true);
expect(isDark()).toBe(true);
});
});

it('should toggle with truthy & falsy', () => {
getTestBed().runInInjectionContext(() => {
const status = signal('ON');
const toggle = useToggle(status, {
truthyValue: 'ON',
falsyValue: 'OFF',
});

expect(status()).toBe('ON');
expect(toggle).toBeTypeOf('function');

expect(toggle()).toBe('OFF');
expect(status()).toBe('OFF');

expect(toggle()).toBe('ON');
expect(status()).toBe('ON');

expect(toggle('OFF')).toBe('OFF');
expect(status()).toBe('OFF');

expect(toggle('ON')).toBe('ON');
expect(status()).toBe('ON');
});
});
});
122 changes: 122 additions & 0 deletions packages/unuse/src/useToggle/index.react.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
// @vitest-environment happy-dom

import { renderHook } from '@testing-library/react';
import { useState } from 'react';
import { expect, it } from 'vitest';
import { describeReact } from '../_testUtils/react';
import type { ToggleFn } from './index';
import { useToggle } from './index';

describeReact('useToggle', () => {
it('default result', () => {
renderHook(() => {
const result = useToggle() as unknown as [
ReturnType<typeof useState<boolean>>,
ToggleFn,
];
const [value, toggle] = result;

expect(Array.isArray(result)).toBe(true);
expect(result).toHaveLength(2);

expect(toggle).toBeTypeOf('function');
expect(value).toSatisfy(Array.isArray);
expect(value[0]).toBe(false);
});
});

it('default result with initialValue', () => {
renderHook(() => {
const result = useToggle(true) as unknown as [
ReturnType<typeof useState<boolean>>,
ToggleFn,
];
const [value, toggle] = result;

expect(Array.isArray(result)).toBe(true);
expect(result).toHaveLength(2);

expect(toggle).toBeTypeOf('function');
expect(value).toBeTypeOf('object');
expect(value[0]).toBe(true);
});
});

it.todo('should toggle', () => {
renderHook(() => {
const result = useToggle() as unknown as [
ReturnType<typeof useState<boolean>>,
ToggleFn,
];
const [value, toggle] = result;

expect(toggle()).toBe(true);
expect(value[0]).toBe(true);

expect(toggle()).toBe(false);
expect(value[0]).toBe(false);
});
});

it.todo('should receive toggle param', () => {
renderHook(() => {
const result = useToggle() as unknown as [
ReturnType<typeof useState<boolean>>,
ToggleFn,
];
const [value, toggle] = result;

expect(toggle(false)).toBe(false);
expect(value[0]).toBe(false);

expect(toggle(true)).toBe(true);
expect(value[0]).toBe(true);
});
});

it.todo('state initialValue', () => {
renderHook(() => {
const isDark = useState(true);
const toggle = useToggle(isDark);

expect(toggle).toBeTypeOf('function');

expect(toggle()).toBe(false);
expect(isDark[0]).toBe(false);

expect(toggle()).toBe(true);
expect(isDark[0]).toBe(true);

expect(toggle(false)).toBe(false);
expect(isDark[0]).toBe(false);

expect(toggle(true)).toBe(true);
expect(isDark[0]).toBe(true);
});
});

it.todo('should toggle with truthy & falsy', () => {
renderHook(() => {
const status = useState('ON');
const toggle = useToggle(status, {
truthyValue: 'ON',
falsyValue: 'OFF',
});

expect(status[0]).toBe('ON');
expect(toggle).toBeTypeOf('function');

expect(toggle()).toBe('OFF');
expect(status[0]).toBe('OFF');

expect(toggle()).toBe('ON');
expect(status[0]).toBe('ON');

expect(toggle('OFF')).toBe('OFF');
expect(status[0]).toBe('OFF');

expect(toggle('ON')).toBe('ON');
expect(status[0]).toBe('ON');
});
});
});
96 changes: 96 additions & 0 deletions packages/unuse/src/useToggle/index.solid.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
import type { Signal } from 'solid-js';
import { createSignal } from 'solid-js';
import { expect, it } from 'vitest';
import { describeSolid } from '../_testUtils/solid';
import type { ToggleFn } from './index';
import { useToggle } from './index';

describeSolid('useToggle', () => {
it('default result', () => {
const result = useToggle() as unknown as [Signal<boolean>, ToggleFn];
const [value, toggle] = result;

expect(Array.isArray(result)).toBe(true);
expect(result).toHaveLength(2);

expect(toggle).toBeTypeOf('function');
expect(value).toSatisfy(Array.isArray);
expect(value[0]()).toBe(false);
});

it('default result with initialValue', () => {
const result = useToggle(true) as unknown as [Signal<boolean>, ToggleFn];
const [value, toggle] = result;

expect(Array.isArray(result)).toBe(true);
expect(result).toHaveLength(2);

expect(toggle).toBeTypeOf('function');
expect(value).toSatisfy(Array.isArray);
expect(value[0]()).toBe(true);
});

it('should toggle', () => {
const result = useToggle() as unknown as [Signal<boolean>, ToggleFn];
const [value, toggle] = result;

expect(toggle()).toBe(true);
expect(value[0]()).toBe(true);

expect(toggle()).toBe(false);
expect(value[0]()).toBe(false);
});

it('should receive toggle param', () => {
const result = useToggle() as unknown as [Signal<boolean>, ToggleFn];
const [value, toggle] = result;

expect(toggle(false)).toBe(false);
expect(value[0]()).toBe(false);

expect(toggle(true)).toBe(true);
expect(value[0]()).toBe(true);
});

it('signal initialValue', () => {
const isDark = createSignal(true);
const toggle = useToggle(isDark);

expect(toggle).toBeTypeOf('function');

expect(toggle()).toBe(false);
expect(isDark[0]()).toBe(false);

expect(toggle()).toBe(true);
expect(isDark[0]()).toBe(true);

expect(toggle(false)).toBe(false);
expect(isDark[0]()).toBe(false);

expect(toggle(true)).toBe(true);
expect(isDark[0]()).toBe(true);
});

it('should toggle with truthy & falsy', () => {
const status = createSignal('ON');
const toggle = useToggle(status, {
truthyValue: 'ON',
falsyValue: 'OFF',
});

expect(status[0]()).toBe('ON');
expect(toggle).toBeTypeOf('function');

expect(toggle()).toBe('OFF');
expect(status[0]()).toBe('OFF');

expect(toggle()).toBe('ON');
expect(status[0]()).toBe('ON');

expect(toggle('OFF')).toBe('OFF');
expect(status[0]()).toBe('OFF');

expect(toggle('ON')).toBe('ON');
expect(status[0]()).toBe('ON');
});
});
Loading
Loading
0