@darwish/hooks-core
Version:
74 lines (73 loc) • 3.06 kB
JavaScript
;
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
var react_1 = __importStar(require("react"));
/**
* @author darwish
* @param defaultValue a boolean value
* @description a hook to toggle boolean value
* @returns `UseBooleanOutput` An object containing the boolean state value and utility functions to manipulate the state.
* @property {Function} `UseBooleanOutput.set` sets the value
* @property {Function} `UseBooleanOutput.value` the current boolean value
* @property {Function} `UseBooleanOutput.setTrue` sets the value to `true`
* @property {Function} `UseBooleanOutput.setFalse` sets the value to `false`
* @property {Function} `UseBooleanOutput.toggle` toggles the value
* @see [Documentation](https://darwish.vercel.app/hooks/use-boolean)
* @example
* const {value, setTrue, setFalse, toggle} = useBoolean(true);
* <button onClick={toggle}>Toggle</button>
*/
var useBoolean = function (defaultValue) {
var _a = react_1.default.useState(!!defaultValue), value = _a[0], setValue = _a[1];
var utils = (0, react_1.useMemo)(function () {
var set = function (settingValue) {
setValue(settingValue);
};
var setTrue = function () { return setValue(true); };
var setFalse = function () { return setValue(false); };
var toggle = function () {
setValue(function (prev) { return !prev; });
};
return {
set: set,
setTrue: setTrue,
setFalse: setFalse,
toggle: toggle,
};
}, [value]);
return __assign({ value: value }, utils);
};
exports.default = useBoolean;