aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/controls/SearchSelect.tsx
blob: 9483a3d51670b43922445461c95c2862981fbe8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
 * SonarQube
 * Copyright (C) 2009-2018 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import * as React from 'react';
import { debounce } from 'lodash';
import Select, { Creatable } from '../../components/controls/Select';
import { translate, translateWithParameters } from '../../helpers/l10n';

interface Props<T> {
  autofocus?: boolean;
  canCreate?: boolean;
  clearable?: boolean;
  defaultOptions?: T[];
  minimumQueryLength?: number;
  multi?: boolean;
  onSearch: (query: string) => Promise<T[]>;
  onSelect?: (option: T) => void;
  onMultiSelect?: (options: T[]) => void;
  promptTextCreator?: (label: string) => string;
  renderOption?: (option: T) => JSX.Element;
  resetOnBlur?: boolean;
  value?: T | T[];
}

interface State<T> {
  loading: boolean;
  options: T[];
  query: string;
}

export default class SearchSelect<T extends { value: string }> extends React.PureComponent<
  Props<T>,
  State<T>
> {
  mounted = false;

  constructor(props: Props<T>) {
    super(props);
    this.state = { loading: false, options: props.defaultOptions || [], query: '' };
    this.handleSearch = debounce(this.handleSearch, 250);
  }

  componentDidMount() {
    this.mounted = true;
  }

  componentWillUnmount() {
    this.mounted = false;
  }

  get autofocus() {
    return this.props.autofocus !== undefined ? this.props.autofocus : true;
  }

  get minimumQueryLength() {
    return this.props.minimumQueryLength !== undefined ? this.props.minimumQueryLength : 2;
  }

  get resetOnBlur() {
    return this.props.resetOnBlur !== undefined ? this.props.resetOnBlur : true;
  }

  handleSearch = (query: string) => {
    // Ignore the result if the query changed
    const currentQuery = query;
    this.props.onSearch(currentQuery).then(
      options => {
        if (this.mounted) {
          this.setState(state => ({
            loading: false,
            options: state.query === currentQuery ? options : state.options
          }));
        }
      },
      () => {
        if (this.mounted) {
          this.setState({ loading: false });
        }
      }
    );
  };

  handleChange = (option: T | T[]) => {
    if (Array.isArray(option)) {
      if (this.props.onMultiSelect) {
        this.props.onMultiSelect(option);
      }
    } else if (this.props.onSelect) {
      this.props.onSelect(option);
    }
  };

  handleInputChange = (query: string) => {
    if (query.length >= this.minimumQueryLength) {
      this.setState({ loading: true, query });
      this.handleSearch(query);
    } else {
      // `onInputChange` is called with an empty string after a user selects a value
      // in this case we shouldn't reset `options`, because it also resets select value :(
      const options = (query.length === 0 && this.props.defaultOptions) || [];
      this.setState({ options, query });
    }
  };

  // disable internal filtering
  handleFilterOption = () => true;

  render() {
    const Component = this.props.canCreate ? Creatable : Select;
    return (
      <Component
        autoFocus={this.autofocus}
        className="input-super-large"
        clearable={this.props.clearable}
        escapeClearsValue={false}
        filterOption={this.handleFilterOption}
        isLoading={this.state.loading}
        multi={this.props.multi}
        noResultsText={
          this.state.query.length < this.minimumQueryLength
            ? translateWithParameters('select2.tooShort', this.minimumQueryLength)
            : translate('select2.noMatches')
        }
        onBlurResetsInput={this.resetOnBlur}
        onChange={this.handleChange}
        onInputChange={this.handleInputChange}
        optionRenderer={this.props.renderOption}
        options={this.state.options}
        placeholder={translate('search_verb')}
        promptTextCreator={this.props.promptTextCreator}
        searchable={true}
        value={this.props.value}
        valueRenderer={this.props.renderOption}
      />
    );
  }
}