Инлайн-редактирование может заменить форму, когда пользователю нужно изменить всего несколько полей среди большого числа параметров.

Country
Capital
Currency

В горизонтальном списке можно менять ширину колонки с названием параметра, устанавливать фиксированную или относительную величину.

Country
Capital
Currency
Text Field
Textarea
Select Multiple
Select

Незаполненное значение параметра нельзя оставлять пустым в режиме просмотра. Вставляйте текстовую заглушку, которая даст понять пользователю, что параметр можно изменить.

По умолчанию используется формулировка «Не заполнено», но лучше под каждый параметр придумать осмысленный текст. Например: «Ответственный: Не назначен», «Окончание работы: Не определено».

Для полей без подписи вместо заглушки можно использовать формулировку с названием поля: описание, оператор, тип инцидента.

Country
Capital
Currency

Выход из режима редактирования запускает попытку применить изменения. Невалидное значение редактор отклоняет: он остаётся открытым, поле подсвечивается, а фокус остаётся там, куда его привело последнее действие.

Сообщение об ошибке нужно подключить самостоятельно. Красный тултип из примера ниже появляется, только если задан validationTooltip; альтернатива — kbq-error внутри kbq-form-field. Вход showTooltipOnError выключает тултип, оставляя само сообщение.

Валидация проверяет сам контрол, а не состояние подсветки ошибки, поэтому редактор отклоняет и значение, которого пользователь не касался: селект, сохраняющийся по (selectionChange), невалидную опцию не запишет.

Not empty
IP-address

Когда заранее известно, какие символы точно не подходят для ввода в поле, система предотвращает ввод некорректных значений. Для этого нужно запрещать ввод определенных символов, например букв в IP-адрес. При этом запрещенные символы не вводятся и показывается желтый тултип.

Если пользователь очистил значение, чтобы избежать ошибки можно при сохранении подставить значение по умолчанию или предыдущее валидное.

Изменение можно сохранять на сервере сразу после выхода из режима редактирования. Для этого в свойство saveHandler нужно передать функцию, которая возвращает поток с запросом. Компонент закрывает редактор, показывает состояние запроса в режиме просмотра и хранит последнее сохраненное значение.

Редактор закрывается раньше, чем отвечает сервер. Поэтому в режиме просмотра поле показывает введенное значение, которое сервер еще не подтвердил.

Если значение не отличается от того, с которым открылся редактор, запрос не уходит. За сравнение отвечает свойство compareWith. По умолчанию компонент сравнивает значения через ===. Такое сравнение подходит для текста и чисел. Для массивов и объектов нужно задать свою функцию. Значение null отключает сравнение: тогда запрос уходит при каждом сохранении. После ошибки запрос уходит даже с тем же значением.

Удаление строки не отменяет запрос: он продолжается и без поля. Событие saveError после удаления строки не приходит. Чтобы сообщить об ошибке и в этом случае, токен KBQ_INLINE_EDIT_SAVE_ERROR_HANDLER нужно объявить в корневом инжекторе.

Если сервер ответил быстрее, чем за 100 мс, поле не показывает индикатор загрузки. Иначе поле в режиме просмотра принимает состояние Progress минимум на 300 мс, чтобы индикатор не мелькал. Пока идет запрос, поле остается в режиме просмотра.

Server response time
Name
Description

Фон значения окрашивается в цвет ошибки и остается таким, пока пользователь не отреагирует. Введенное значение остается в поле.

За сообщение об ошибке отвечает приложение, а не компонент. Общую реакцию задает токен KBQ_INLINE_EDIT_SAVE_ERROR_HANDLER. Для отдельного поля эту реакцию заменяет свойство saveErrorHandler или подписка на событие saveError. В обработчик приходит ошибка и поле с действиями retrySave(), toggleMode() и rollback().

Сообщение не закрывается по таймауту. Закрытие сообщения и отказ от изменений откатывают несохраненное значение.

Отмена редактирования не снимает состояние ошибки. В поле остается значение, которое отклонил сервер, поэтому ошибка держится до успешного сохранения или до вызова rollback().

Save Admins, Support as the name to have the value rejected. Saving the description fails on the first attempt and succeeds on retry.

Name
Description

Сервер может отклонить не все значение, а его часть. Тогда отклоненные элементы нужно сопоставить с тем, что показано в режиме просмотра, и отметить их, а не все значение.

Add user:delete, user:update to the roles to have the server reject them.

Roles

При наведении или фокусе на поле справа можно показать кнопку дополнительного действия или меню: скопировать текст, добавить значение в фильтр, очистить поле, заполнить по шаблону.

Дополнительные действия оттеняют значение и располагаются в правом верхнем углу. Когда открыто меню, то сохраняется видимой подсветка и иконка.

Vertical list
Style
Founded
Horizontal listStyle
Founded

Редактор можно открывать и закрывать программно: привяжите [(mode)] и присвойте 'edit' или 'view'.

Spanish football is characterized by technical skill, tactical innovation, and fierce regional rivalries. La Liga, founded in 1929, features some of the world's best clubs. Spain's national team dominated world football from 2008-2012, winning two European Championships and a World Cup with their 'tiki-taka' style.

Элементы с возможностью инлайн-редактирования должны быть выровнены в соответствии с их видом в режиме просмотра, без учета дополнительных отступов у фона при наведении, фокусе или редактировании.

Parameters with inline editing are visually left-aligned with other elements on the screen
Country
Capital
Currency
Tags
Critical
High
Medium
Low
Icon + Text

При выборе открываем только выпадающее меню, но не показываем поле ввода, как у Select. Рамка поля ввода не требуется — достаточно выпадающего меню.

Status
Priority

После выбора опции поле возвращается в режим просмотра.

Иногда стоит делать опции в выпадающем списке многострочными. Рекомендуется выравнивать ширину выпадающего меню по ширине поля.

Resolution comment

Разместите элемент для очистки в выпадающем меню — ведь самого поля селекта не видно, поэтому другого подходящего места для кнопки сброса нет.

Рекомендуем также добавить опцию, название которой явно даёт понять, что значение не установлено. Это будет логично перекликаться с формулировкой пустого поля в режиме просмотра.

Assignee

После выбора опции поле возвращается в режим просмотра.

Поле — одна точка табуляции.

Клавиша
РежимЧто делает
Enter / SpaceПросмотрОткрывают редактор
EnterРедактированиеСохраняет значение и переводит поле в режим просмотра, кроме кнопок
EscРедактированиеЗакрывает редактор и восстанавливает прежнее значение
TabРедактированиеС первого или последнего контрола сохраняет значение и уводит фокус с поля
EnterРедактирование в textareaВставляет перенос строки
Ctrl / Cmd + EnterРедактирование в textareaСохраняет значение; это правило меняет вход canSaveOnEnter

Нажатие вне поля сохраняет значение и закрывает редактор так же, как Tab. При выходе из режима редактирования фокус возвращается на поле — кроме выхода по Tab: он передаёт фокус соседней точке табуляции, в ту сторону, куда шёл. Если эта точка принадлежит другому inline edit, открывается его редактор, поэтому колонку полей можно заполнить за один проход; если её нет, поле забирает фокус себе.

Контрол, у которого есть собственное действие по Enter, — кнопка или элемент с role="button" — это действие и выполняет, а поле не сохраняет: иначе одно нажатие делало бы и то, и другое. Поле с незавершённым запросом saveHandler сохраняет и точку табуляции, и кольцо фокуса: в отличие от отключённого оно остаётся достижимым, просто пока не открывается.

Содержимое, которое само обрабатывает нажатия — ссылка, тег, — сохраняет своё поведение вместо того, чтобы открыть редактор. Список такого содержимого задаёт вход interactiveSelectors, по умолчанию ['a', 'kbq-tag']; этот вход заменяет список целиком, а не дополняет его, поэтому нужные значения по умолчанию повторите явно. Когда в режиме просмотра есть такое содержимое, собственная точка табуляции поля переходит на соседний визуально скрытый элемент, чтобы с клавиатуры были доступны и содержимое, и редактор.

Режим просмотра объявляется как button с aria-expanded, поэтому вспомогательные технологии сообщают и то, что значение можно изменить, и то, открыт ли редактор. Имя по умолчанию — локализованное «Редактировать»; задайте полю собственное через aria-label там, где по одному значению непонятно, что именно изменяется:

<kbq-inline-edit aria-label="Ответственный">…</kbq-inline-edit>

Отключённое поле сообщает aria-disabled и выходит из порядка табуляции. Кнопки сохранения и отмены из showActions состоят из одних иконок и берут имена из секции локали a11y — оттуда же берётся имя edit.

Ход сохранения на сервере передан не только цветом: поле объявляет его в скрытой области role="status" словами из той же секции локали — saving и saveFailed.

Библиотека задаёт элементу с kbqInlineEditMenu атрибут role="button", но имени ему не даёт, поэтому задайте aria-label самостоятельно.

Поле с инлайн-редактированием должны сохраняться сразу после изменения без общей для всего экрана кнопки «Сохранить».

Не используйте:

  • Внутри форм
  • При создании сущности — спроектируйте форму для заполнения информации.
  • Когда в поле сложная валидация. Например, пароль, эл. почта, уникальные поля, а также когда требуются маски, подсказки.
  • Для зависимых полей — если изменение одного поля влияет на другие, лучше использовать форму.
  • Для изменения важных данных.
  • Когда требуется дополнительно подтверждения для сохранения. Например, диалог «Вы точно уверены?»

Заменой инлайн-редактированию может быть:

  • Модальное окно или поповер с формой — для сложных или многострочных данных.
  • Отдельная страница редактирования — когда нужен контроль над вводом.
  • Инлайн-форма — поле раскрывается в более крупный редактор
Предложения по улучшению
Если вы нашли ошибку или хотите доработать статью, создайте запрос на GitHub.