Skip to content

Commit

Permalink
Update component and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Nov 2, 2020
1 parent 69bc887 commit 4f95eb1
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 8 deletions.
51 changes: 46 additions & 5 deletions src/components/QueueSelector/QueueSelector.js
Original file line number Diff line number Diff line change
@@ -1,16 +1,57 @@
import React from "react";
import PropTypes from "prop-types";
import { TextField, Checkbox} from "@material-ui/core";
import { Autocomplete } from "@material-ui/lab";
import CheckBoxOutlineBlankIcon from '@material-ui/icons/CheckBoxOutlineBlank';
import CheckBoxIcon from '@material-ui/icons/CheckBox';

export default function QueueSelector(){
return (
QueueSelector
export default function QueueSelector({ queues, selectedQueues, setSelectedQueues }) {
return(
<Autocomplete
options={queues}
onChange={(event, newValue) => {
setSelectedQueues(newValue)
}}
renderInput={(params) => {
return(
<TextField
{...params}
placeholder={selectedQueues.length === 0 ? "Click to select queues." : ""}
/>
);
}}
getOptionLabel={(option) => `${option.name} (${option.number_of_items})`}
renderOption={(option, { selected }) => (
<>
<Checkbox
icon={<CheckBoxOutlineBlankIcon fontSize="small" />}
checkedIcon={<CheckBoxIcon fontSize="small" />}
style={{ marginRight: 8 }}
checked={selected}
/>
{`${option.name} (${option.number_of_items})`}
</>
)}
getOptionSelected={ (option, value) => option.name === value.name }
disableCloseOnSelect
autoComplete
disableListWrap
openOnFocus
fullWidth
multiple
/>
);
};

QueueSelector.propTypes = {

/** An array of objects with keys of name and number of items for each queue. */
"queues": PropTypes.array,
/** State variable to manage selected queues. */
"selectedQueues": PropTypes.array.isRequired,
/** Function to update state variable that manages selected queues. */
"setSelectedQueues": PropTypes.func.isRequired
};

QueueSelector.defaultProps = {

"queues": []
};
33 changes: 30 additions & 3 deletions src/components/QueueSelector/QueueSelector.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,38 @@
QueueSelector
Allows the selection, removal and viewing of active queues. Its extends the [MUI Autocomplete component](https://material-ui.com/components/autocomplete/).

---
```jsx
import React, { useState } from "react";
import { Paper, makeStyles } from "@material-ui/core";
import QueueSelector from "./QueueSelector";

<QueueSelector />
const [selectedQueues, setSelectedQueues] = useState([]);
const queues = [
{
'name': 'bidc',
'number_of_items': 5
},
{
'name': 'epics',
'number_of_items': 6
},
{
'name': 'wang',
'number_of_items': 13
}
];

const useStyles = makeStyles({
root: {
padding: "16px",
}
});
const classes = useStyles();

<Paper classes={{ root: classes.root }}>
<QueueSelector queues={queues} selectedQueues={selectedQueues} setSelectedQueues={setSelectedQueues} />
</Paper>
```
```jsx static
<QueueSelector />
<QueueSelector queues={queues} selectedQueues={selectedQueues} setSelectedQueues={setSelectedQueues} />
```

0 comments on commit 4f95eb1

Please sign in to comment.