diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/full-page-edit.png b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/full-page-edit.png deleted file mode 100644 index 3799ce662f..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/full-page-edit.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/full-table-edit.png b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/full-table-edit.png deleted file mode 100644 index 36a001ec46..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/full-table-edit.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/row-editing.png b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/row-editing.png deleted file mode 100644 index e5bdc42942..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/row-editing.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/specific-field-edit.png b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/specific-field-edit.png deleted file mode 100644 index 8726cedfee..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/specific-field-edit.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/table-inline-edit-elements.png b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/table-inline-edit-elements.png deleted file mode 100644 index ee9b0fb69f..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/img/table-inline-edit-elements.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/inline-edit.md b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/inline-edit.md index 25370f3269..766000a71b 100644 --- a/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/inline-edit.md +++ b/packages/documentation-site/patternfly-docs/content/design-guidelines/components/inline-edit/inline-edit.md @@ -7,7 +7,7 @@ import '../components.css'; ## Elements -Elements vary depending on inline edit variation +Elements vary depending on the inline edit variation. Refer to element annotations with the page and table inline elements sections: * [Page inline elements](#page-inline-elements) * [Table inline elements](#table-inline-elements) @@ -22,20 +22,22 @@ Elements vary depending on inline edit variation ## Behavior -
+When an inline edit is triggered (either a [field-specific edit](#field-specific-edit), a [full-page edit](#full-page-edit), or a [table edit](#table-edit)), users can adjust existing values as needed. Saving the edit will change the value in the element to match a user's update. + +
![Example of the behavior of an inline edit field.](./img/inline-edit-behavior.gif)
## 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). -2. **[Table inline edit](/components/inline-edit/design-guidelines#table-inline-edit):** enables the user to [edit elements in a row](/components/inline-edit/design-guidelines#row-editing). +1. **[Page inline edit](#page-inline-edit):** Enables the user to edit a [specific field](#field-specific-edit) in a details page or in a [full page](#full-page-edit). +2. **[Table inline edit](#table-inline-edit):** Enables the user to [edit elements in a row](#row-editing). ### Page inline edit -* **[Field-specific edit](/components/inline-edit/design-guidelines#field-specific-edit):** allows users to make changes to one field at a time -* **[Full page edit](/components/inline-edit/design-guidelines#full-page-edit):** allows users to make multiple changes at a time, in a larger area with more fields +* **[Field-specific edit](#field-specific-edit):** Allows users to make changes to one field at a time. +* **[Full page edit](#full-page-edit):** Allows users to make multiple changes at a time, in a larger area with more fields. -### Page inline elements +#### Page inline elements
![Elements of field specific inline edits.](./img/inline-edit-page-elements-1.svg) @@ -44,9 +46,9 @@ Elements vary depending on inline edit variation ![Elements of full page inline edits](./img/inline-edit-page-elements-2.svg)
-1. **Toggle:** Indicates the edit action -2. **[Tooltip](/components/tooltip):** Provides a short description of the inline edit toggle -3. **Action group:** Allows the user to save or cancel changes +1. **Pencil toggle (fa-pencil-alt):** Indicates the edit action. +2. **[Tooltip](/components/tooltip):** Provides a short description of the inline edit toggle. +3. **Action group:** Allows the user to save or cancel changes. 4. **Form elements:** Examples include [text input](/components/forms/text-input) or [text area](/components/forms/text-area). See [forms](/components/forms/form) for more information about form elements. ### Field-specific edit @@ -57,23 +59,23 @@ Use field-specific edit when you want to allow users to make small edits to spec #### How to use The pencil toggle is placed inline with the header for fields that are editable. Clicking on this toggle allows the user to edit inline, or can trigger a modal for more complex edits. In edit mode: -* **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. +* **The check icon (fa-check)** saves the changes and switches the item back to read-only mode. +* **The close icon (fa-times)** returns to the read-only mode without saving new data.
![Example of field specific inline edits.](./img/inline-edit-field-specific.svg)
-### Full page edit +### Full-page edit #### When to use Use the full-page edit when you want to allow users to edit a larger area with many editable elements all at once. #### How to use Any editing is triggered by an edit link for the whole section. All edits should be easily done in the context of the page. Clicking the pencil icon toggles the page or description list into edit mode. -* **Non Editable fields**, for example, Name, and Labels should use read-only styling. +* **Non-editable fields** should use read-only styling. For example, "Name", and "Labels". * **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. +* 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.
![Example of full page inline edits.](./img/inline-edit-full-page.svg) @@ -81,43 +83,40 @@ Any editing is triggered by an edit link for the whole section. All edits should ### Table inline edit -* **[Row edit](/components/inline-edit/design-guidelines#row-editing):** allows for making changes to 1 editable row in the table +* **[Row edit](#row-editing):** Allows users to make changes to a specific table row. -### Table inline elements +#### Table inline elements
![Elements of inline edits in a table.](./img/inline-edit-table.svg)
-1. **Editable inactive row:** Inactive row with read-only styling -2. **Editable active row:** Ability to edit form components is enabled -3. **Disabled input field:** Unclickable and unusable input field -4. **Editable input field:** Changes for this input are allowed -5. **Active input:** Selected input field with new content -6. **Action group:** Allows user to save or cancel changes -7. **[Tooltip](/components/tooltip):** Provides a short description of the inline edit toggle -8. **Toggle:** Indicates the edit action +1. **Editable inactive row:** Inactive row with read-only styling. +2. **Editable active row:** Ability to edit form components is enabled. +3. **Disabled input field:** Non-clickable and unusable input field. +4. **Editable input field:** Changes for this input are allowed. +5. **Active input:** Selected input field with new content. +6. **Action group:** Allows users to save or cancel changes. +7. **[Tooltip](/components/tooltip):** Provides a short description of the inline edit toggle. +8. **Toggle:** Indicates the edit action. -### Row editing -Row editing allows a user to edit items that are visible in the table by having a pencil toggle pinned to the right side, with the [kebab](/components/menus/dropdown#with-kebab). +#### Row editing +Row editing allows a user to edit items that are visible in the table by having a pencil toggle pinned to the right side, with the [kebab toggle (fa-ellipsis-v)](/components/menus/dropdown#with-kebab). -#### When to use +##### When to use Use row editing when: * You need to change the data in a table. -* The data is not dependent on each other. For example, changing the data in a row five will not affect row three. +* The data is not dependent on each other. For example, changing the data in row 5 will not affect row 3. -#### How to use +##### How to use Clicking the pencil icon toggles the particular table row into edit mode. In the edit mode: -* The kebab is replaced with a check icon for saving and a close icon for canceling. Both icons should be grey until changes have begun to be made. -* Once changes begin, the check icon turns blue to increase the visibility of the save action. -* **The check icon button** submits the changes and switches the row back to the read-only mode. +* The kebab is replaced with a check icon for saving and a close icon for canceling. +* Once changes begin, the check icon turns to `global/icon/brand/default` (in this case, PatternFly blue) to increase the visibility of the save action. +* **The check icon button** submits the changes and switches the row back to read-only mode. * **The close icon** returns to read-only mode without saving new data.
![Example of inline edits in a table.](./img/inline-edit-table-rows.svg)
-Some are elements may be difficult to edit in a table. You can make them editable in a [modal](/components/modal) instead. - - - +Some elements may be difficult to edit in a table. You can make them editable in a [modal](/components/modal) instead. \ No newline at end of file