element-web/src/components/views/elements/Slider.tsx

/*
Copyright 2020 The Matrix.org Foundation C.I.C.

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 * as React from 'react';
import * as PropTypes from 'prop-types';
import { replaceableComponent } from '../../../utils/replaceableComponent';

type SliderProps = {
        // A callback for the selected value
        onSelectionChange: (value: number) => null;

        // The current value of the slider
        value: number;

        // The range and values of the slider
        // Currently only supports an ascending, constant interval range
        values: number[];

        // A function for formatting the the values
        displayFunc: (value: number) => string;

}

export default class Slider extends React.Component<SliderProps> {
    static propTypes = {

        // A callback for the new value onclick
        onSelectionChange: PropTypes.func,

        // The current value of the slider
        value: PropTypes.number,

        // The range and values of the slider
        // Currently only supports an ascending, constant interval range
        values: PropTypes.arrayOf(PropTypes.number),

        // A function for formatting the the values
        displayFunc: PropTypes.func,

    };

    _offset(values: number[], value: number): number {
        return (value - values[0]) / (values[values.length - 1] - values[0]) * 100;
    }

    render(): React.ReactNode {
        const dots = this.props.values.map(v =>
            <Dot active={v <= this.props.value}
                 label={this.props.displayFunc(v)}
                 onClick={() => this.props.onSelectionChange(v)}
                 key={v}
            />);

        const offset = this._offset(this.props.values, this.props.value);

        return <div className="mx_Slider">
            <div>
                <div className="mx_Slider_bar">
                    <hr />
                    <div className="mx_Slider_selection">
                        <div className="mx_Slider_selectionDot" style={{left: "calc(-0.55rem + " + offset + "%)"}} />
                        <hr style={{width: offset + "%"}} />
                    </div>
                </div>
                <div className="mx_Slider_dotContainer">
                    {dots}
                </div>
            </div>
        </div>;
    }
}

type DotProps = {
    // Callback for behaviour onclick
    onClick: () => null,

    // Whether the dot should appear active
    active: boolean,

    // The label on the dot
    label: string,
}

@replaceableComponent("views.elements.Dot")
class Dot extends React.Component<DotProps> {
    static propTypes = {
        // Callback for behaviour onclick
        onClick: PropTypes.func,

        // Whether the dot should appear active
        active: PropTypes.bool,

        // The label on the dot
        label: PropTypes.string,
    }

    render(): React.ReactNode {
        const className = "mx_Slider_dot" + (this.props.active ? " mx_Slider_dotActive" : "");

        return <span onClick={this.props.onClick} className="mx_Slider_dotValue">
            <div className={className} />
            <div>
                {this.props.label}
            </div>
        </span>;
    }
}