@blueprintjs/core
Version:
Core styles & components
95 lines • 5.41 kB
JavaScript
;
/*
* Copyright 2025 Palantir Technologies, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.Spinner = exports.SpinnerSize = void 0;
var tslib_1 = require("tslib");
var classnames_1 = tslib_1.__importDefault(require("classnames"));
var React = tslib_1.__importStar(require("react"));
var common_1 = require("../../common");
var errors_1 = require("../../common/errors");
var props_1 = require("../../common/props");
var utils_1 = require("../../common/utils");
var useValidateProps_1 = require("../../hooks/useValidateProps");
var SpinnerSize;
(function (SpinnerSize) {
SpinnerSize[SpinnerSize["SMALL"] = 20] = "SMALL";
SpinnerSize[SpinnerSize["STANDARD"] = 50] = "STANDARD";
SpinnerSize[SpinnerSize["LARGE"] = 100] = "LARGE";
})(SpinnerSize || (exports.SpinnerSize = SpinnerSize = {}));
// see http://stackoverflow.com/a/18473154/3124288 for calculating arc path
var R = 45;
var SPINNER_TRACK = "M 50,50 m 0,-".concat(R, " a ").concat(R, ",").concat(R, " 0 1 1 0,").concat(R * 2, " a ").concat(R, ",").concat(R, " 0 1 1 0,-").concat(R * 2);
// unitless total length of SVG path, to which stroke-dash* properties are relative.
// https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/pathLength
// this value is the result of `<path d={SPINNER_TRACK} />.getTotalLength()` and works in all browsers:
var PATH_LENGTH = 280;
var MIN_SIZE = 10;
var STROKE_WIDTH = 4;
var MIN_STROKE_WIDTH = 16;
/**
* Spinner component.
*
* @see https://blueprintjs.com/docs/#core/components/spinner
*/
var Spinner = function (props) {
var _a;
var _b = props.className, className = _b === void 0 ? "" : _b, intent = props.intent, value = props.value, _c = props.tagName, tagName = _c === void 0 ? "div" : _c, size = props.size, htmlProps = tslib_1.__rest(props, ["className", "intent", "value", "tagName", "size"]);
(0, useValidateProps_1.useValidateProps)(function () {
var isSizePropSet = size != null;
var isSizeClassSet = className.indexOf(common_1.Classes.SMALL) >= 0 || className.indexOf(common_1.Classes.LARGE) >= 0;
if (isSizePropSet && isSizeClassSet) {
console.warn(errors_1.SPINNER_WARN_CLASSES_SIZE);
}
}, [className, size]);
var sizePx = getSize(size, className);
// keep spinner track width consistent at all sizes (down to about 10px).
var strokeWidth = Math.min(MIN_STROKE_WIDTH, (STROKE_WIDTH * SpinnerSize.LARGE) / sizePx);
var strokeOffset = PATH_LENGTH - PATH_LENGTH * (value == null ? 0.25 : (0, utils_1.clamp)(value, 0, 1));
var classes = (0, classnames_1.default)(common_1.Classes.SPINNER, common_1.Classes.intentClass(intent), (_a = {}, _a[common_1.Classes.SPINNER_NO_SPIN] = value != null, _a), className);
// multiple DOM elements around SVG are necessary to properly isolate animation:
// - SVG elements in IE do not support anim/trans so they must be set on a parent HTML element.
// - SPINNER_ANIMATION isolates svg from parent display and is always centered inside root element.
return React.createElement(tagName, tslib_1.__assign({ "aria-label": "loading", "aria-valuemax": 100, "aria-valuemin": 0, "aria-valuenow": value === undefined ? undefined : value * 100, className: classes, role: "progressbar" }, htmlProps), React.createElement(tagName, { className: common_1.Classes.SPINNER_ANIMATION }, React.createElement("svg", { width: sizePx, height: sizePx, strokeWidth: strokeWidth.toFixed(2), viewBox: getViewBox(strokeWidth) },
React.createElement("path", { className: common_1.Classes.SPINNER_TRACK, d: SPINNER_TRACK }),
React.createElement("path", { className: common_1.Classes.SPINNER_HEAD, d: SPINNER_TRACK, pathLength: PATH_LENGTH, strokeDasharray: "".concat(PATH_LENGTH, " ").concat(PATH_LENGTH), strokeDashoffset: strokeOffset }))));
};
exports.Spinner = Spinner;
exports.Spinner.displayName = "".concat(props_1.DISPLAYNAME_PREFIX, ".Spinner");
/**
* Resolve size to a pixel value.
* Size can be set by className, props, default, or minimum constant.
*/
var getSize = function (size, className) {
if (size == null) {
if (className.indexOf(common_1.Classes.SMALL) >= 0) {
return SpinnerSize.SMALL;
}
else if (className.indexOf(common_1.Classes.LARGE) >= 0) {
return SpinnerSize.LARGE;
}
return SpinnerSize.STANDARD;
}
return Math.max(MIN_SIZE, size);
};
/** Compute viewbox such that stroked track sits exactly at edge of image frame. */
var getViewBox = function (strokeWidth) {
var radius = R + strokeWidth / 2;
var viewBoxX = (50 - radius).toFixed(2);
var viewBoxWidth = (radius * 2).toFixed(2);
return "".concat(viewBoxX, " ").concat(viewBoxX, " ").concat(viewBoxWidth, " ").concat(viewBoxWidth);
};
//# sourceMappingURL=spinner.js.map