Skip to content
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
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the gif came out teeny tiny 😆 🤏

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So yeah if it's showing valid behavior then I agree with you that's a weird placement currently. I think there should really be a Behavior section that holds that gif, where we describe the interaction.. Hm, do you want to create an h2 ##Behavior between the Usage and Variations section, and just stick the gif there for this pr? I could add the content in a Docs follow up

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just adding a note for Docs here since it's contextually related, but might want to update the content to call out the specific icon names (right now we just say check and close, but I think we should do fa-check or whatever)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Comment thread
bekah-stephens marked this conversation as resolved.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also note for Docs, i think some of the bullet points related to this aren't applicable anymore, need to review.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ id: Inline edit
section: components
---

import '../components.css';

## Elements

Elements vary depending on inline edit variation
Expand All @@ -18,7 +20,11 @@ Elements vary depending on inline edit variation
### When not to use
* The editing is the primary function of the view. For example, in an edit modal.

<img src="./img/inline-edit.gif" alt="Inline edit components" width="960" height="540" />.
## Behavior

<div class="ws-docs-content-img">
![Example of the behavior of an inline edit field.](./img/inline-edit-behavior.gif)
</div>

## Variations
1. **[Page inline edit](/components/inline-edit/design-guidelines#page-inline-edit):** enables the user to edit a [specific field](/components/inline-edit/design-guidelines#table-inline-edit) in a details page or in a [full page](/components/inline-edit/design-guidelines#full-page-edit).
Expand All @@ -31,7 +37,12 @@ Elements vary depending on inline edit variation

### Page inline elements

<img src="./img/elements-form-inline-edit.png" alt="Form inline edit elements" width="785"/>
<div class="ws-docs-content-img">
![Elements of field specific inline edits.](./img/inline-edit-page-elements-1.svg)
</div>
<div class="ws-docs-content-img">
![Elements of full page inline edits](./img/inline-edit-page-elements-2.svg)
</div>

1. **Toggle:** Indicates the edit action
2. **[Tooltip](/components/tooltip):** Provides a short description of the inline edit toggle
Expand All @@ -49,7 +60,9 @@ The pencil toggle is placed inline with the header for fields that are editable.
* **The check icon** saves the changes and switches the item back to read-only mode.
* **The close icon** returns to the read-only mode without saving new data.

<img src="./img/specific-field-edit.png" alt="Specific field edit" width="1013"/>
<div class="ws-docs-content-img">
![Example of field specific inline edits.](./img/inline-edit-field-specific.svg)
</div>

### Full page edit

Expand All @@ -62,15 +75,19 @@ Any editing is triggered by an edit link for the whole section. All edits should
* **Editable fields** should function like any form.
* Users can save or cancel changes using the ‘Save’ or ‘Cancel’ button. Both actions return a page or description list to the read-only mode.

<img src="./img/full-page-edit.png" alt="Full page edit" width="926"/>
<div class="ws-docs-content-img">
![Example of full page inline edits.](./img/inline-edit-full-page.svg)
</div>

### Table inline edit

* **[Row edit](/components/inline-edit/design-guidelines#row-editing):** allows for making changes to 1 editable row in the table

### Table inline elements

<img src="./img/table-inline-edit-elements.png" alt="Table inline edit elements" width="1010"/>
<div class="ws-docs-content-img">
![Elements of inline edits in a table.](./img/inline-edit-table.svg)
</div>

1. **Editable inactive row:** Inactive row with read-only styling
2. **Editable active row:** Ability to edit form components is enabled
Expand All @@ -96,7 +113,9 @@ Clicking the pencil icon toggles the particular table row into edit mode. In the
* **The check icon button** submits the changes and switches the row back to the read-only mode.
* **The close icon** returns to read-only mode without saving new data.

<img src="./img/row-editing.png" alt="Row editing" width="1210"/>
<div class="ws-docs-content-img">
![Example of inline edits in a table.](./img/inline-edit-table-rows.svg)
</div>

Some are elements may be difficult to edit in a table. You can make them editable in a [modal](/components/modal) instead.

Expand Down