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.

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

Add in-progress view to EditInPlace component #180

Merged
merged 6 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
dbkr marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
t3chguy marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 20 additions & 5 deletions src/components/Form/Controls/EditInPlace/EditInPlace.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,15 @@ limitations under the License.

.caption-line {
margin-block-start: var(--cpd-space-2x);
display: flex;
align-items: center;
gap: var(--cpd-space-2x);
}

.caption-icon {
display: inline-block;
vertical-align: middle;
inline-size: 20px;
block-size: 20px;
margin-inline-end: var(--cpd-space-2x);
}

.caption-icon-error {
Expand All @@ -107,18 +108,28 @@ limitations under the License.

.caption-icon-saved {
background-color: var(--cpd-color-icon-success-primary);

/*
* We are trying to match the size of the error icon which
* is displayed 20px big but has 2px of border in an SVG
* with a viewBox of 24x24...
*/
inline-size: calc(20px * (20 / 24));
block-size: calc(20px * (20 / 24));
margin: calc(2px * (20 / 24));
border-radius: 20px;
text-align: center;
margin-inline-end: var(--cpd-space-2x);

svg {
color: var(--cpd-color-icon-on-solid-primary);
position: relative;
inset-block-start: -1px;
}
}

.caption-text {
vertical-align: middle;
font-size: 13px;
font-size: var(--cpd-font-body-sm-medium);
font-weight: var(--cpd-font-weight-medium);
}

.caption-text-error {
Expand All @@ -128,3 +139,7 @@ limitations under the License.
.caption-text-saved {
color: var(--cpd-color-text-success-primary);
}

.caption-text-saving {
color: var(--cpd-color-text-secondary);
}
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ export default {
saveButtonLabel: {
type: "string",
},
savingLabel: {
type: "string",
},
cancelButtonLabel: {
type: "string",
},
Expand All @@ -83,6 +86,7 @@ export default {
value: "",
saveButtonLabel: "Save",
cancelButtonLabel: "Cancel",
savingLabel: "Saving...",
},
} satisfies Meta<Props>;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ describe("EditInPlace", () => {
cancelButtonLabel="Cancel"
savedLabel={"Saved"}
disableSaveButton={props.disableSaveButton}
savingLabel="Saving..."
/>
</Control>
</Field>
Expand Down
20 changes: 20 additions & 0 deletions src/components/Form/Controls/EditInPlace/EditInPlace.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import useId from "../../../../utils/useId";
import CheckIcon from "@vector-im/compound-design-tokens/icons/check.svg";
import CancelIcon from "@vector-im/compound-design-tokens/icons/close.svg";
import ErrorIcon from "@vector-im/compound-design-tokens/icons/error.svg";
import { InlineSpinner } from "../../../InlineSpinner/InlineSpinner";

type Props = {
/**
Expand Down Expand Up @@ -67,6 +68,11 @@ type Props = {
*/
saveButtonLabel: string;

/**
* The label for the 'in progress' saving caption
*/
savingLabel: string;

/**
* True to disable the save button, false to enable.
* Default: false (enabled)
Expand Down Expand Up @@ -96,6 +102,7 @@ export const EditInPlace = forwardRef<HTMLInputElement, Props>(
disableSaveButton,
error,
savedLabel,
savingLabel,
...props
},
ref,
Expand Down Expand Up @@ -211,6 +218,19 @@ export const EditInPlace = forwardRef<HTMLInputElement, Props>(
</span>
</div>
)}
{saving && (
<div className={styles["caption-line"]}>
<InlineSpinner />
<span
className={classnames(
styles["caption-text"],
styles["caption-text-saving"],
)}
>
{savingLabel}
</span>
</div>
)}
{savedLabel && showSaved && (
<div className={styles["caption-line"]}>
<div
Expand Down
35 changes: 35 additions & 0 deletions src/components/InlineSpinner/InlineSpinner.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
Copyright 2024 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

@keyframes spin {
from {
transform: rotateZ(0deg);
}

to {
transform: rotateZ(360deg);
}
}

.icon {
color: var(--cpd-color-icon-secondary);
display: inline-flex;
justify-content: center;
align-items: center;
inline-size: 100%;
block-size: 100%;
animation: 1s linear spin infinite;
}
36 changes: 36 additions & 0 deletions src/components/InlineSpinner/InlineSpinner.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
Copyright 2024 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { Meta } from "@storybook/react";

import { InlineSpinner as InlineSpinnerComponent } from "./InlineSpinner";

export default {
title: "InlineSpinner",
component: InlineSpinnerComponent,
tags: ["autodocs"],
argTypes: {
size: {
type: "number",
},
},
args: {},
} as Meta<typeof InlineSpinnerComponent>;

export const Default = {
args: {},
parameters: {},
};
28 changes: 28 additions & 0 deletions src/components/InlineSpinner/InlineSpinner.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
Copyright 2024 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import { describe, it, expect } from "vitest";
import { render } from "@testing-library/react";
import React from "react";

import { InlineSpinner } from "./InlineSpinner";

describe("InlineSpinner", () => {
it("renders", () => {
const { asFragment } = render(<InlineSpinner />);
expect(asFragment()).toMatchSnapshot();
});
});
34 changes: 34 additions & 0 deletions src/components/InlineSpinner/InlineSpinner.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
Copyright 2024 New Vector Ltd

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import React, { forwardRef } from "react";
import styles from "./InlineSpinner.module.css";
import SpinnerIcon from "@vector-im/compound-design-tokens/icons/spinner.svg";

type InlineSpinnerProps = {
size?: number;
} & React.HTMLAttributes<HTMLDivElement>;

export const InlineSpinner = forwardRef<HTMLDivElement, InlineSpinnerProps>(
function InlineSpinner({ size = 20 }: InlineSpinnerProps) {
return (
<SpinnerIcon
className={styles.icon}
style={{ width: size, height: size }}
/>
);
},
);
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`InlineSpinner > renders 1`] = `
<DocumentFragment>
<svg
class="_icon_01cd2d"
fill="currentColor"
height="1em"
style="width: 20px; height: 20px;"
viewBox="0 0 24 24"
width="1em"
xmlns="http://www.w3.org/2000/svg"
>
<path
clip-rule="evenodd"
d="M12 4.031a8 8 0 1 0 8 8 1 1 0 0 1 2 0c0 5.523-4.477 10-10 10s-10-4.477-10-10 4.477-10 10-10a1 1 0 1 1 0 2Z"
fill-rule="evenodd"
/>
</svg>
</DocumentFragment>
`;
Loading