Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: indicate clearly that a plugin needs configuration #1614

Merged
merged 7 commits into from
Sep 10, 2023
Merged

Feature: indicate clearly that a plugin needs configuration #1614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3bc96bd
Fix: 1601 - Make pit clear that configuration is needed
JacoKoster Sep 8, 2023
a06706e
Merge branch 'SignalK:master' into fix-plugin-ux
JacoKoster Sep 9, 2023
b444a03
Fix vertical alignment of configure button
JacoKoster Sep 9, 2023
3e96e58
Merge branch 'SignalK:master' into fix-plugin-ux
JacoKoster Sep 10, 2023
0cf7be3
Align the text of the plugin
JacoKoster Sep 10, 2023
39f7297
Formmatted code
JacoKoster Sep 10, 2023
52c1354
Merge branch 'master' into fix-plugin-ux
JacoKoster Sep 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/server-admin-ui/scss/_custom.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,12 @@ form.rjsf div.row.array-item {
background-color: aliceblue;
margin-bottom: 3px;
}

@media (max-width: 767px) {
.container-fluid, .row {
padding:0 2px !important;
}
.navbar-header {
margin:0px;
}
}
162 changes: 92 additions & 70 deletions packages/server-admin-ui/src/views/Configuration/Configuration.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import React, { Component } from 'react'
import PluginConfigurationForm from './../ServerConfig/PluginConfigurationForm'
import {
Alert,
Button,
Container,
Card,
CardBody,
CardHeader,
Expand Down Expand Up @@ -91,52 +91,58 @@ export default class PluginConfigurationList extends Component {

render() {
return (
<Container>
<Form
action=""
method="post"
encType="multipart/form-data"
className="form-horizontal"
onSubmit={(e) => {
e.preventDefault()
}}
>
<FormGroup row>
<Col xs="3" md="1" className={'col-form-label'}>
<Label htmlFor="select">Search</Label>
</Col>
<Col xs="12" md="4">
<Input
type="text"
name="search"
onChange={this.handleSearch}
value={this.state.search}
<Card>
<CardHeader>
<i className="fa fa-align-justify" />
<strong>Plugin Configuration</strong>
</CardHeader>
<CardBody>
<Form
action=""
method="post"
encType="multipart/form-data"
className="form-horizontal"
onSubmit={(e) => {
e.preventDefault()
}}
>
<FormGroup row>
<Col xs="3" md="1" className={'col-form-label'}>
<Label htmlFor="select">Search</Label>
</Col>
<Col xs="12" md="4">
<Input
type="text"
name="search"
onChange={this.handleSearch}
value={this.state.search}
/>
</Col>
</FormGroup>
</Form>

{(this.state.searchResults || this.state.plugins).map((plugin, i) => {
const isOpen =
localStorage.getItem(openPluginStorageKey) === plugin.id
return (
<PluginCard
plugin={plugin}
isConfigurator={isConfigurator(plugin)}
key={i}
isOpen={isOpen}
toggleForm={this.toggleForm.bind(this, i, plugin.id)}
saveData={(data) => {
if (plugin.data.configuration === undefined) {
data.enabled = true
}
this.props.history.replace(`/serverConfiguration/plugins/-`)
this.saveData(plugin.id, data, i)
}}
/>
</Col>
</FormGroup>
</Form>
{(this.state.searchResults || this.state.plugins).map((plugin, i) => {
//const isOpen = this.props.match.params.pluginid === plugin.id
const isOpen =
localStorage.getItem(openPluginStorageKey) === plugin.id
return (
<PluginCard
plugin={plugin}
isConfigurator={isConfigurator(plugin)}
key={i}
isOpen={isOpen}
toggleForm={this.toggleForm.bind(this, i, plugin.id)}
saveData={(data) => {
if (plugin.data.configuration === undefined) {
data.enabled = true
}
this.props.history.replace(`/serverConfiguration/plugins/-`)
this.saveData(plugin.id, data, i)
}}
/>
)
})}
</Container>
)
})}
</CardBody>
</Card>
)
}

Expand Down Expand Up @@ -166,12 +172,12 @@ class PluginCard extends Component {
render() {
const labelStyle = { marginLeft: '10px', marginBottom: '0px' }
const { schema } = this.props.plugin
const noConfigurationRequired =
const configurationRequired =
schema &&
schema.properties &&
Object.keys(this.props.plugin.schema.properties).length == 0
const canbeEnabled =
this.props.plugin.data.configuration || noConfigurationRequired
Object.keys(schema?.properties).length != 0 &&
this.props.plugin.data.configuration == null

return (
<div
ref={(card) => {
Expand All @@ -181,7 +187,11 @@ class PluginCard extends Component {
<Card>
<CardHeader>
<Row>
<Col xs={4} onClick={this.props.toggleForm}>
<Col
sm={4}
onClick={this.props.toggleForm}
className={'align-self-center'}
>
<i
style={{ marginRight: '10px' }}
className={
Expand All @@ -190,22 +200,33 @@ class PluginCard extends Component {
/>
{this.props.plugin.name}
</Col>
{!this.props.plugin.data.configuration && !this.props.isOpen && (
<Col xs="2">
<Button
size="sm"
color="primary"
style={{ width: '100%' }}
onClick={this.props.toggleForm}
>
Configure
</Button>
</Col>
{configurationRequired && !this.props.isOpen && (
<Fragment>
<Col sm={6} lg={3}>
<div
className="alert alert-warning mb-0 mt-2 mt-sm-0 pb-1 pt-1 btn-sm"
role="alert"
>
<i className="fa fa-exclamation-triangle"></i> Plugin is
disabled, configuration missing
</div>
</Col>
<Col sm={2} className={'d-none d-sm-block'}>
<Button
size="sm"
color="primary"
className="mt-0"
style={{ width: '100%' }}
onClick={this.props.toggleForm}
>
Configure
</Button>
</Col>
</Fragment>
)}
{canbeEnabled && (
{!configurationRequired && (
<Fragment>
<Col xs="2">
Enabled
<Col lg={2} className={'mt-2 mt-lg-0'}>
<Label
style={labelStyle}
className="switch switch-text switch-primary"
Expand All @@ -229,9 +250,9 @@ class PluginCard extends Component {
/>
<span className="switch-handle" />
</Label>
<span className="ml-1">Enabled</span>
</Col>
<Col xs="3">
Data Logging
<Col lg={2} className={'mt-2 mt-lg-0'}>
<Label
style={labelStyle}
className="switch switch-text switch-primary"
Expand All @@ -256,17 +277,17 @@ class PluginCard extends Component {
/>
<span className="switch-handle" />
</Label>
<span className="ml-1">Data logging</span>
</Col>
<Col xs="3">
Enable debug log
<Col lg={2} className={'mt-2 mt-lg-0'}>
<Label
style={labelStyle}
className="switch switch-text switch-primary"
>
<Input
type="checkbox"
name="enableDebug"
className="switch-input"
className="switch-input "
onChange={(e) => {
this.props.saveData({
...this.props.plugin.data,
Expand All @@ -282,6 +303,7 @@ class PluginCard extends Component {
/>
<span className="switch-handle" />
</Label>
<span className="ml-1">Enable debug log</span>
</Col>
</Fragment>
)}
Expand Down