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

Update Globals Button Rendering #493

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Update Globals Button Rendering #493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ecf2f7e
Update text and header handling
garrettmflynn Nov 1, 2023
fd750b2
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Nov 1, 2023
d8f2e2d
Merge branch 'main' into update-globals-button-rendering
CodyCBakerPhD Nov 1, 2023
88a124c
Merge branch 'main' into update-globals-button-rendering
CodyCBakerPhD Nov 1, 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
29 changes: 22 additions & 7 deletions src/renderer/src/stories/Button.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import { LitElement, html, css } from "lit";
import { styleMap } from "lit/directives/style-map.js";
import { unsafeHTML } from "lit/directives/unsafe-html.js";

export class Button extends LitElement {
constructor({ primary, label, color = null, size, onClick, buttonStyles } = {}) {
constructor({ icon = null, primary, label, color = null, size, onClick, buttonStyles } = {}) {
super();
this.icon = icon;
this.label = label;
this.primary = primary;
this.color = color;
Expand All @@ -18,20 +20,29 @@ export class Button extends LitElement {
display: inline-block;
}

.button-icon {
margin-right: 10px;
}

.storybook-button {
padding: 10px 15px;
font-family: "Nunito Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
font-weight: 700;
border: 0;
border-radius: 5px;
cursor: pointer;
display: inline-block;
line-height: 1;
display: flex;
align-items: center;
justify-content: center;
}

.button-icon {
margin-right: 7px;
}

svg {
margin: 0px !important;
width: auto;
height: 25px;
}

.storybook-button--primary {
color: white;
background-color: hsl(190, 60%, 36%);
Expand Down Expand Up @@ -89,7 +100,11 @@ export class Button extends LitElement {
)}
@click=${this.onClick}
>
${this.icon ? html`<span class="button-icon">${this.icon}</span>` : ""}
${this.icon
? html`<span class="button-icon"
>${this.icon instanceof HTMLElement ? this.icon : unsafeHTML(this.icon)}</span
>`
: ""}
<slot>${this.label ?? ""}</slot>
</button>
`;
Expand Down
113 changes: 63 additions & 50 deletions src/renderer/src/stories/JSONSchemaForm.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,9 @@ const componentCSS = `
margin: 15px;
}

hr {
margin: 1em 0 1.5em 0;
}
hr {
margin: 1em 0 1.5em 0;
}

pre {
white-space: pre-wrap; /* Since CSS 2.1 */
Expand Down Expand Up @@ -137,14 +137,19 @@ hr {
border-bottom: 1px solid gainsboro;
}

.guided--text-input-instructions {
font-size: 13px;
width: 100%;
padding-top: 4px;
color: dimgray !important;
margin: 0 0 1em;
line-height: 1.4285em;
}
.guided--text-input-instructions {
font-size: 13px;
width: 100%;
padding-top: 4px;
color: dimgray !important;
margin: 0 0 1em;
line-height: 1.4285em;
}

[disabled] {
opacity: 0.5;
pointer-events: none;
}
`;

document.addEventListener("dragover", (e) => {
Expand Down Expand Up @@ -841,45 +846,51 @@ export class JSONSchemaForm extends LitElement {
if (this.mode === "accordion" && hasMany) {
const headerName = header(name);

this.#nestedForms[name] = new JSONSchemaForm({
identifier: this.identifier,
schema: info,
results: { ...results[name] },
globals: this.globals?.[name],

states: this.states,

mode: this.mode,

onUpdate: (internalPath, value) => {
const path = [...localPath, ...internalPath];
this.updateData(path, value);
},

required: required[name], // Scoped to the sub-schema
ignore: this.ignore,
dialogOptions: this.dialogOptions,
dialogType: this.dialogType,
onlyRequired: this.onlyRequired,
showLevelOverride: this.showLevelOverride,
deferLoading: this.deferLoading,
conditionalRequirements: this.conditionalRequirements,
validateOnChange: (...args) => this.validateOnChange(...args),
onThrow: (...args) => this.onThrow(...args),
validateEmptyValues: this.validateEmptyValues,
onStatusChange: (status) => {
accordion.setSectionStatus(headerName, status);
this.checkStatus();
}, // Forward status changes to the parent form
onInvalid: (...args) => this.onInvalid(...args),
onLoaded: () => {
this.nLoaded++;
this.checkAllLoaded();
},
renderTable: (...args) => this.renderTable(...args),
onOverride: (...args) => this.onOverride(...args),
base: [...this.base, ...localPath],
});
// Check properties that will be rendered before creating the accordion
const base = [...this.base, ...localPath];
const renderable = this.#getRenderable(info, required[name], base);

if (renderable.length) {
this.#nestedForms[name] = new JSONSchemaForm({
identifier: this.identifier,
schema: info,
results: { ...results[name] },
globals: this.globals?.[name],

states: this.states,

mode: this.mode,

onUpdate: (internalPath, value) => {
const path = [...localPath, ...internalPath];
this.updateData(path, value);
},

required: required[name], // Scoped to the sub-schema
ignore: this.ignore,
dialogOptions: this.dialogOptions,
dialogType: this.dialogType,
onlyRequired: this.onlyRequired,
showLevelOverride: this.showLevelOverride,
deferLoading: this.deferLoading,
conditionalRequirements: this.conditionalRequirements,
validateOnChange: (...args) => this.validateOnChange(...args),
onThrow: (...args) => this.onThrow(...args),
validateEmptyValues: this.validateEmptyValues,
onStatusChange: (status) => {
accordion.setSectionStatus(headerName, status);
this.checkStatus();
}, // Forward status changes to the parent form
onInvalid: (...args) => this.onInvalid(...args),
onLoaded: () => {
this.nLoaded++;
this.checkAllLoaded();
},
renderTable: (...args) => this.renderTable(...args),
onOverride: (...args) => this.onOverride(...args),
base,
});
}

if (!this.states[headerName]) this.states[headerName] = {};
this.states[headerName].subtitle = `${
Expand All @@ -895,6 +906,8 @@ export class JSONSchemaForm extends LitElement {

accordion.id = name; // assign name to accordion id

if (!renderable.length) accordion.setAttribute("disabled", "");

return accordion;
}

Expand Down
4 changes: 2 additions & 2 deletions src/renderer/src/stories/Main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,11 +152,11 @@ export class Main extends LitElement {
style="position: sticky; padding: 0px 50px; top: 0; left: 0; background: white; z-index: 1;"
>
<div style="display: flex; flex: 1 1 0px; justify-content: space-between; align-items: end;">
<div style="white-space: nowrap; overflow: hidden; text-overflow: ellipsis; color:gray;">
<div style="line-height: 1em; color: gray;">
<h1 class="title" style="margin: 0; padding: 0; color:black;">${title}</h1>
<small>${unsafeHTML(subtitle)}</small>
</div>
<div style="padding-left: 25px">${controls}</div>
<div style="padding-left: 25px;">${controls}</div>
</div>
<hr style="margin-bottom: 0;" />
</div>`
Expand Down
1 change: 1 addition & 0 deletions src/renderer/src/stories/assets/global.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion src/renderer/src/stories/pages/guided-mode/data/GuidedMetadata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ import { createGlobalFormModal } from "../../../forms/GlobalFormModal";
import { Button } from "../../../Button.js";
import { globalSchema } from "../../../../../../../schemas/base-metadata.schema";

import globalIcon from "../../../assets/global.svg?raw";

const propsToIgnore = [
"Ophys", // Always ignore ophys metadata (for now)
"Icephys", // Always ignore icephys metadata (for now)
Expand Down Expand Up @@ -51,6 +53,7 @@ export class GuidedMetadataPage extends ManagedPage {
header = {
controls: [
new Button({
icon: globalIcon,
label: "Edit Global Metadata",
onClick: () => {
this.#globalModal.form.results = merge(this.info.globalState.project, {});
Expand Down Expand Up @@ -92,7 +95,7 @@ export class GuidedMetadataPage extends ManagedPage {
super.connectedCallback();

const modal = (this.#globalModal = createGlobalFormModal.call(this, {
header: "Edit Global Metadata",
header: "Global Metadata",
propsToRemove: [...propsToIgnore],
schema: globalSchema, // Provide HARDCODED global schema for metadata properties (not automatically abstracting across sessions)...
hasInstances: true,
Expand Down
7 changes: 5 additions & 2 deletions src/renderer/src/stories/pages/guided-mode/data/GuidedSourceData.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import { createGlobalFormModal } from "../../../forms/GlobalFormModal";
import { header } from "../../../forms/utils";
import { Button } from "../../../Button.js";

import globalIcon from "../../../assets/global.svg?raw";

const propsToIgnore = [
"verbose",
"es_key",
Expand All @@ -33,7 +35,8 @@ export class GuidedSourceDataPage extends ManagedPage {
header = {
controls: [
new Button({
label: "Edit Global Metadata",
icon: globalIcon,
label: "Edit Global Source Data",
onClick: () => {
this.#globalModal.form.results = merge(this.info.globalState.project?.SourceData, {});
this.#globalModal.open = true;
Expand Down Expand Up @@ -162,7 +165,7 @@ export class GuidedSourceDataPage extends ManagedPage {
connectedCallback() {
super.connectedCallback();
const modal = (this.#globalModal = createGlobalFormModal.call(this, {
header: "Edit Global Source Data",
header: "Global Source Data",
propsToRemove: [...propsToIgnore, "folder_path", "file_path"],
key: "SourceData",
schema: this.info.globalState.schema.source_data,
Expand Down
5 changes: 4 additions & 1 deletion src/renderer/src/stories/pages/guided-mode/setup/GuidedSubjects.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { Button } from "../../../Button.js";
import { createGlobalFormModal } from "../../../forms/GlobalFormModal";
import { header } from "../../../forms/utils";

import globalIcon from "../../../assets/global.svg?raw";

export class GuidedSubjectsPage extends Page {
constructor(...args) {
super(...args);
Expand All @@ -20,6 +22,7 @@ export class GuidedSubjectsPage extends Page {
subtitle: "Enter all metadata known about each experiment subject",
controls: [
new Button({
icon: globalIcon,
label: "Edit Global Metadata",
onClick: () => {
this.#globalModal.form.results = merge(this.info.globalState.project?.Subject, {});
Expand Down Expand Up @@ -88,7 +91,7 @@ export class GuidedSubjectsPage extends Page {
connectedCallback() {
super.connectedCallback();
const modal = (this.#globalModal = createGlobalFormModal.call(this, {
header: "Edit Global Subject Data",
header: "Global Subject Metadata",
key: "Subject",
schema: globalSchema.properties.Subject,
validateOnChange: (key, parent, path) => {
Expand Down
Loading