@byndyusoft-ui/use-throttled-callback
Version:
Byndyusoft UI React Hook
102 lines (101 loc) • 6 kB
JavaScript
;
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;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ThrottledCallbackStory = void 0;
const react_1 = __importStar(require("react"));
const useThrottledCallback_1 = __importDefault(require("../useThrottledCallback"));
const useThrottledCallback_stories_module_css_1 = __importDefault(require("./useThrottledCallback.stories.module.css"));
const DELAY_THROTTLE = 1500;
const UseThrottledCallbackStory = () => {
const [count, setCount] = (0, react_1.useState)(0);
const [noLeadingCount, setNoLeadingCount] = (0, react_1.useState)(0);
const [noTrailingCount, setNoTrailingCount] = (0, react_1.useState)(0);
const throttledHandleClickLeading = (0, useThrottledCallback_1.default)(() => {
setCount(prevCount => prevCount + 1);
}, DELAY_THROTTLE);
const throttledHandleClickNoLeading = (0, useThrottledCallback_1.default)(() => {
setNoLeadingCount(prevCount => prevCount + 1);
}, DELAY_THROTTLE, { leading: false });
const throttledHandleClickNoTrailing = (0, useThrottledCallback_1.default)(() => {
setNoTrailingCount(prevCount => prevCount + 1);
}, DELAY_THROTTLE, { trailing: false });
return (react_1.default.createElement("div", null,
react_1.default.createElement("div", { className: `${useThrottledCallback_stories_module_css_1.default.column} ${useThrottledCallback_stories_module_css_1.default.card}` },
react_1.default.createElement("h3", null, "Default"),
react_1.default.createElement("code", { className: useThrottledCallback_stories_module_css_1.default.code_block }, `
const handleClick = useThrottledCallback(() => {
setCount(prevCount => prevCount + 1);
}, 1500)
`),
react_1.default.createElement("div", { className: useThrottledCallback_stories_module_css_1.default.row },
react_1.default.createElement("p", null,
"Count: ",
count),
react_1.default.createElement("button", { className: useThrottledCallback_stories_module_css_1.default.btn, onClick: throttledHandleClickLeading }, "Click me"))),
react_1.default.createElement("div", { className: useThrottledCallback_stories_module_css_1.default.card },
react_1.default.createElement("h3", null, "Off leading"),
react_1.default.createElement("ul", null,
react_1.default.createElement("li", null, "The function will not be called immediately on the first call"),
react_1.default.createElement("li", null, "The function will be called only after the delay is completed")),
react_1.default.createElement("pre", { className: useThrottledCallback_stories_module_css_1.default.code_block }, `
const handleClick = useThrottledCallback(() => {
setCount(prevCount => prevCount + 1);
},
1500,
{ leading: false })
`),
react_1.default.createElement("div", { className: useThrottledCallback_stories_module_css_1.default.row },
react_1.default.createElement("p", null,
"Count: ",
noLeadingCount),
react_1.default.createElement("button", { className: useThrottledCallback_stories_module_css_1.default.btn, onClick: throttledHandleClickNoLeading }, "Click me"))),
react_1.default.createElement("div", { className: useThrottledCallback_stories_module_css_1.default.card },
react_1.default.createElement("h3", null, "Off trailing"),
react_1.default.createElement("ul", null,
react_1.default.createElement("li", null, "The function will not be called after the delay is completed"),
react_1.default.createElement("li", null, "The function will be called only on the first call if the leading option is set to true")),
react_1.default.createElement("pre", { className: useThrottledCallback_stories_module_css_1.default.code_block }, `
const handleClick = useThrottledCallback(() => {
setCount(prevCount => prevCount + 1);
},
1500,
{ trailing: false })
`),
react_1.default.createElement("div", { className: useThrottledCallback_stories_module_css_1.default.row },
react_1.default.createElement("p", null,
"Count: ",
noTrailingCount),
react_1.default.createElement("button", { className: useThrottledCallback_stories_module_css_1.default.btn, onClick: throttledHandleClickNoTrailing }, "Click me")))));
};
exports.ThrottledCallbackStory = {
name: 'Throttled click',
render: UseThrottledCallbackStory
};
exports.default = {
title: 'hooks/useThrottledCallback'
};