@blueprintjs/core
Version:
Core styles & components
104 lines • 5.09 kB
JavaScript
/*
* Copyright 2015 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.
*/
import classNames from "classnames";
import * as React from "react";
import { AbstractPureComponent, Classes } from "../../common";
import { SPINNER_WARN_CLASSES_SIZE } from "../../common/errors";
import { DISPLAYNAME_PREFIX } from "../../common/props";
import { clamp } from "../../common/utils";
export var SpinnerSize;
(function (SpinnerSize) {
SpinnerSize[SpinnerSize["SMALL"] = 20] = "SMALL";
SpinnerSize[SpinnerSize["STANDARD"] = 50] = "STANDARD";
SpinnerSize[SpinnerSize["LARGE"] = 100] = "LARGE";
})(SpinnerSize || (SpinnerSize = {}));
// see http://stackoverflow.com/a/18473154/3124288 for calculating arc path
const R = 45;
const SPINNER_TRACK = `M 50,50 m 0,-${R} a ${R},${R} 0 1 1 0,${R * 2} a ${R},${R} 0 1 1 0,-${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:
const PATH_LENGTH = 280;
const MIN_SIZE = 10;
const STROKE_WIDTH = 4;
const MIN_STROKE_WIDTH = 16;
/**
* Spinner component.
*
* @see https://blueprintjs.com/docs/#core/components/spinner
*/
export class Spinner extends AbstractPureComponent {
static displayName = `${DISPLAYNAME_PREFIX}.Spinner`;
componentDidUpdate(prevProps) {
if (prevProps.value !== this.props.value) {
// IE/Edge: re-render after changing value to force SVG update
this.forceUpdate();
}
}
render() {
const { className, intent, value, tagName = "div", ...htmlProps } = this.props;
const size = this.getSize();
const classes = classNames(Classes.SPINNER, Classes.intentClass(intent), { [Classes.SPINNER_NO_SPIN]: value != null }, className);
// keep spinner track width consistent at all sizes (down to about 10px).
const strokeWidth = Math.min(MIN_STROKE_WIDTH, (STROKE_WIDTH * SpinnerSize.LARGE) / size);
const strokeOffset = PATH_LENGTH - PATH_LENGTH * (value == null ? 0.25 : clamp(value, 0, 1));
// 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, {
"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: Classes.SPINNER_ANIMATION }, React.createElement("svg", { width: size, height: size, strokeWidth: strokeWidth.toFixed(2), viewBox: this.getViewBox(strokeWidth) },
React.createElement("path", { className: Classes.SPINNER_TRACK, d: SPINNER_TRACK }),
React.createElement("path", { className: Classes.SPINNER_HEAD, d: SPINNER_TRACK, pathLength: PATH_LENGTH, strokeDasharray: `${PATH_LENGTH} ${PATH_LENGTH}`, strokeDashoffset: strokeOffset }))));
}
validateProps({ className = "", size }) {
if (size != null && (className.indexOf(Classes.SMALL) >= 0 || className.indexOf(Classes.LARGE) >= 0)) {
console.warn(SPINNER_WARN_CLASSES_SIZE);
}
}
/**
* Resolve size to a pixel value.
* Size can be set by className, props, default, or minimum constant.
*/
getSize() {
const { className = "", size } = this.props;
if (size == null) {
// allow Classes constants to determine default size.
if (className.indexOf(Classes.SMALL) >= 0) {
return SpinnerSize.SMALL;
}
else if (className.indexOf(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. */
getViewBox(strokeWidth) {
const radius = R + strokeWidth / 2;
const viewBoxX = (50 - radius).toFixed(2);
const viewBoxWidth = (radius * 2).toFixed(2);
return `${viewBoxX} ${viewBoxX} ${viewBoxWidth} ${viewBoxWidth}`;
}
}
//# sourceMappingURL=spinner.js.map