@blackcube/aurelia-kit 1.0.0-rc6 → 1.0.0-rc8

package/README.md

@@ -496,7 +496,13 @@ Behavior:
 
 - Listens on `Channels.Menu`: `MenuAction.Open` applies the show classes and opens the overlay, `MenuAction.Close`
   applies the hide classes and closes the overlay, `MenuAction.Toggle` does one or the other. `aria-hidden` follows.
-- A click on `[data-menu=close]` closes the menu; the menu closes too when the overlay closes.
+- A click on `[data-menu=close]` closes the menu; the menu closes too when the overlay closes, on `Escape` and on a
+  click on a link of the menu (the link is followed).
+- Open, the focus is trapped in the menu (`ITrapFocusService`), on `[data-menu=close]` first; once closed, it goes back
+  to what opened the menu (the burger).
+- The page follows: `<body>` takes the classes of the menu's `data-menu-page-show` while it is open and of its
+  `data-menu-page-hide` once closed — `data-menu-page-show="overflow-hidden"` keeps the page from scrolling under it.
+  Without these attributes, the page is left as is.
 - Publishes `MenuStatus.Opening`, `Opened`, `Closing`, `Closed` on `Channels.MenuStatus`.
 - `[data-menu=toggle-button-ID]` shows or hides `[data-menu=toggle-list-ID]` (`hidden` attribute), sets the
   data-menu-show / data-menu-hide classes of its `svg[data-menu=icon]` and its `aria-expanded`. Accordion: opening a
@@ -742,6 +748,25 @@ loaded by ajaxify):
 
 When attached, the element is focused on the next frame; the browser brings it into view.
 
+### `bleet-first-error`
+
+A form whose first field in error takes the focus when the page says « refused » (a SPA validating its form before
+posting it):
+
+```html
+<form bleet-first-error="account" submit.trigger="onSubmit($event)" novalidate>
+    <input aria-invalid.bind="…" …>
+</form>
+```
+
+`Channels.Form` carries `IForm` (`{ action: FormAction.FirstError, id?: string }`): the form whose `id` is given,
+every form without id, focuses its first `[aria-invalid=true]` on the next frame — once the invalid marks of the fields
+are rendered. A form without a field in error does nothing.
+
+```typescript
+resolve(IEventAggregator).publish(Channels.Form, <IForm>{ action: FormAction.FirstError, id: 'account' });
+```
+
 ## Upload channel
 
 `Channels.Upload` carries `IUpload` (`{ action: UploadAction.Reset, id?: string }`) for the upload bridges