Skip to content

Commit

Permalink
cluster-ui: show database info and ability to choose statement columns
Browse files Browse the repository at this point in the history
Information about database is now displayed on Statements page and
Statements Details page.
By default the column database is not displayed, but with the new column
selector option, it can be selected.
New filter allows to select statements based on database name.

Closes: #33316

Release note (ui change): Display database name information on Statements
page (hidden by default) and Statements Details page.

New filter option for statements based on databases name.

New option to select which columns to display on statements table.

Release note (bug fix): Transaction page showing correct value for implicit txn.
  • Loading branch information
maryliag committed Apr 28, 2021
1 parent e60d936 commit 5703945
Show file tree
Hide file tree
Showing 23 changed files with 704 additions and 88 deletions.
2 changes: 1 addition & 1 deletion packages/cluster-ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"license": "MIT",
"dependencies": {
"@babel/runtime": "^7.12.13",
"@cockroachlabs/crdb-protobuf-client": "^0.0.10-beta.0",
"@cockroachlabs/crdb-protobuf-client": "^0.0.11",
"@cockroachlabs/icons": "0.3.0",
"@cockroachlabs/ui-components": "0.2.18",
"@popperjs/core": "^2.4.0",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
@import "../core/index.module";

.apply-btn {
&__wrapper {
text-align: end;
}

&__btn {
height: $line-height--large;
width: 67px;
font-size: $font-size--small;
}
}

.checkbox {
&__input {
margin-right: 5px;
}
&__label {
cursor: pointer;
}
}

.dropdown {
position: relative;
&__indicator {
color: $colors--neutral-11;
height: $line-height--medium;
width: 32px;
}
}

.float {
float: left;
margin-right: 7px;
}

.label {
height: 16px;
font-family: $font-family--base;
font-weight: $font-weight--bold;
font-size: $font-size--small;
line-height: $line-height--small;
letter-spacing: 0.3px;
font-style: normal;
margin-bottom: 8px;
margin-left: 10px;
}

.menu {
background-color: white;
border-radius: 4px;
box-shadow: 0px 0px 4px rgba(154, 161, 171, 33%);
margin-top: 8px;
position: absolute;
z-index: 2;
}
253 changes: 253 additions & 0 deletions packages/cluster-ui/src/columnsSelector/columnsSelector.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
import Select, { components, OptionsType } from "react-select";
import React from "react";
import classNames from "classnames/bind";
import styles from "./columnsSelector.module.scss";
import { Button } from "../button";
import {
dropdown,
dropdownContentWrapper,
hidden,
} from "../queryFilter/filterClasses";
import { List } from "@cockroachlabs/icons";

const cx = classNames.bind(styles);

export interface SelectOption {
label: string;
value: string;
isSelected: boolean;
}

export interface ColumnsSelectorProps {
options: SelectOption[];
selected: string[];
onSubmitColumns: (selected: string[]) => void;
}

export interface ColumnsSelectorState {
hide: boolean;
value: string[];
}

/**
* Create all options items using the values from options
* on ColumnsSelector()
* The options must have the parameters label and isSelected
* @param props
* @constructor
*/
const CheckboxOption = (props: any) => {
return (
<components.Option {...props}>
<input
type="checkbox"
className={cx("checkbox__input")}
checked={props.isSelected}
onChange={() => null}
/>
<label className={cx("checkbox__label")}>{props.label}</label>
</components.Option>
);
};

// customStyles uses the default styles provided from the
// react-select component and add changes
const customStyles = {
container: (provided: any) => ({
...provided,
border: "none",
height: "fit-content",
}),
control: (provided: any) => ({
...provided,
display: "none",
}),
menu: (provided: any) => ({
...provided,
position: "relative",
boxShadow: "none",
}),
option: (provided: any, state: any) => ({
...provided,
backgroundColor: "white",
color: "#394455",
cursor: "pointer",
padding: "4px 10px",
}),
multiValue: (provided: any) => ({
...provided,
backgroundColor: "#E7ECF3",
borderRadius: "3px",
}),
};

/**
* Creates the ColumnsSelector from the props
* @param props:
* options (SelectOption[]): a list of options. Each option object must contain a
* label, value and isSelected parameters
* selected (string): a list of the selected value. e.g. 'column1,column3,column4'
* onSubmitColumns (callback function): receives the selected string
* @constructor
*/
export default class ColumnsSelector extends React.Component<
ColumnsSelectorProps,
ColumnsSelectorState
> {
constructor(props: ColumnsSelectorProps) {
super(props);
this.state = {
hide: true,
value: this.props.selected,
};
}
dropdownRef: React.RefObject<HTMLDivElement> = React.createRef();

componentDidMount() {
window.addEventListener("click", this.outsideClick, false);
}
componentWillUnmount() {
window.removeEventListener("click", this.outsideClick, false);
}

toggleOpen = () => {
this.setState({
hide: !this.state.hide,
});
};
outsideClick = () => {
this.setState({ hide: true });
};
insideClick = (event: any) => {
event.stopPropagation();
};

// Update the list of selected values.
// If "all" was deselected, remove everything from the list,
// if the value "all" was selected or all other values were selected,
// add all items (including "all") to the list,
// If all values are selected, add "all" to the list,
// if any other value was deselected, remove "all" from the list.
handleChange = (
selectedOptions: OptionsType<SelectOption>,
allOptions: OptionsType<SelectOption>,
) => {
let selected = selectedOptions.map(function(option: SelectOption) {
return option.value;
});

if (this.wasAllDeselected(selected)) {
selected = [];
} else if (this.wasAllSelect(selected)) {
selected = allOptions.map(function(option: SelectOption) {
return option.value;
});
} else {
const index = selected.indexOf("all", 0);
if (index > -1) {
selected.splice(index, 1);
}
}
this.setState({
value: selected,
});
};
// Check if the value "all" was the selected option or
// if the value "all" should be selected because all
// other values were selected.
wasAllSelect = (newSelection: string[]): boolean => {
return (
(this.state.value !== undefined &&
!this.state.value.includes("default") &&
newSelection.includes("all") &&
!this.state.value.includes("all")) ||
this.isAllSelected(newSelection)
);
};
wasAllDeselected = (newSelection: string[]): boolean => {
return (
!newSelection.includes("all") &&
(this.state.value === undefined ||
this.state.value.includes("all") ||
this.state.value.includes("default"))
);
};
handleSubmit = () => {
this.props.onSubmitColumns(this.state.value);
this.setState({ hide: true });
};

isAllSelected = (selected: string[]) => {
if (selected == undefined) return false;
// If the current selection includes "all" and the size of current list (excluding "all")
// is the same as the total size of all options, then "all" should be selected.
if (selected.includes("all"))
return selected.length - 1 == this.props.options.length;

// If the current list doesn't contain "all" but it's "default" or has the same size
// as the total size of all options, "all" should be selected.
return (
selected.includes("default") ||
selected.length == this.props.options.length
);
};

render() {
const { hide, value } = this.state;
const { options } = this.props;
const dropdownArea = hide ? hidden : dropdown;
const optionsWithAll = [
{
label: "All",
value: "all",
isSelected: this.isAllSelected(this.state.value),
},
].concat(options);
const columnsSelected = optionsWithAll.filter(option => {
if (option.value == "all") return this.isAllSelected(this.state.value);
return (
value == undefined ||
value.includes("default") ||
value.includes(option.value)
);
});

return (
<div
onClick={this.insideClick}
ref={this.dropdownRef}
className={cx("float")}
>
<Button type="secondary" size="small" onClick={this.toggleOpen}>
<List />
</Button>
<div className={dropdownArea}>
<div className={dropdownContentWrapper}>
<div className={cx("label")}>Hide/show columns</div>
<Select
isMulti
menuIsOpen={true}
options={optionsWithAll}
value={columnsSelected}
onChange={selected => this.handleChange(selected, optionsWithAll)}
hideSelectedOptions={false}
closeMenuOnSelect={false}
components={{ Option: CheckboxOption }}
styles={customStyles}
controlShouldRenderValue={false}
/>
<div className={cx("apply-btn__wrapper")}>
<Button
className={cx("apply-btn__btn")}
textAlign="center"
onClick={this.handleSubmit}
>
Apply
</Button>
</div>
</div>
</div>
</div>
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ import classNames from "classnames/bind";

const cx = classNames.bind(styles);

const defaultSelectProps = {
searchable: false,
clearable: false,
};

export interface SelectOption {
label: string;
value: string;
Expand Down Expand Up @@ -112,7 +107,6 @@ export const MultiSelectCheckbox = (props: MultiSelectCheckboxProps) => {
closeMenuOnSelect={false}
components={{ Option: CheckboxOption }}
styles={customStyles}
{...defaultSelectProps}
/>
);
};
1 change: 1 addition & 0 deletions packages/cluster-ui/src/queryFilter/filter.module.scss
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ $dropdown-hover-color: darken($colors--background, 2.5%);
border: 0.5px solid #E5E5E5;
box-shadow: 0px 0px 4px rgba(154, 161, 171, 0.33);
border-radius: 4px;
z-index: 2;

.dropdown-content-wrapper {
padding: 18px 20px 22px 16px;
Expand Down
Loading

0 comments on commit 5703945

Please sign in to comment.