ruby_everywhere 0.1.15 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63effa5f5f00816aa20ada48ca9e1d29fd016dc98b294da2bc0c7d8e1e09d853
-  data.tar.gz: 9f998859661f637feac481d87de6964de030b45fdf197b0c4f72286a1f80fb63
+  metadata.gz: b255975aa8724cb4980606ddbde415eea3a238c193ffce8530028ef5fdc63c24
+  data.tar.gz: 386145d42d750984da4fa800ea9b63417371937dbf67d49642a229cd92cfbb71
 SHA512:
-  metadata.gz: 86c4032c3973f6e85dcfbb4e8e203f30acd41639c261fc1df07e43dd1c9ee31f681eb445c2a4197d656ec3e96c3b7de94ddd22bd9e3e60ac8ad392038229d0bc
-  data.tar.gz: cc951a4ebdc8ecefffee7d418a871fe4e50fd74b676810a522792d0463aebb638307c7aaed124c2699f9b153f4e74ec8201907731a1049a43d8b8caa68c6c7ac
+  metadata.gz: 6af24db6e60c693ae855fa47832564074d887c18248a63be23c343c5e85c7d84cf4210017ba6bb26dae9950bb6b1394255f02cbea4d278f9407952a22f37dd6c
+  data.tar.gz: 368f12504a2a5748aa30eaf641eadf5b85bbd54b99e0f372015b9621510f01dc5779ca6e3e37cfab594083768815e40e48200e2c3649195c5b5e800cc7cf5557

data/bridge/README.md

@@ -33,10 +33,108 @@ Everywhere.confirm("Sure?")          // Promise<boolean>, native dialog when pos
 Everywhere.on("menu", handler)       // shell events; returns an unsubscribe fn
 Everywhere.visit("/settings")        // Turbo.visit with location fallback
 
+Everywhere.menu({ title, items })    // Promise<item | null> — native action
+                                     // sheet in the shell, a styled bottom
+                                     // sheet everywhere else. items:
+                                     // [{ title, id?, style?, disabled? }]
+
 Everywhere.clipboard.write(text)     // Promise<void>
 Everywhere.clipboard.read()          // Promise<string | null>
+
+Everywhere.haptics.impact("medium")  // real haptics in the mobile shell;
+Everywhere.haptics.notification("success") // Vibration API in browsers, no-op elsewhere
+Everywhere.haptics.selection()
+
+Everywhere.badge.set(3)              // app icon badge (mobile / installed PWAs)
+Everywhere.badge.clear()
+Everywhere.badge.setTab("/inbox", 3) // native tab bar badge (mobile)
+Everywhere.badge.clearTab("/inbox")
+
+Everywhere.permissions.query("camera")   // Promise<{name, status}>
+Everywhere.permissions.request("camera") // prompts when possible
+Everywhere.permissions.openSettings()    // for the denied dead-end (iOS asks once)
+// status: "granted" | "denied" | "prompt" | "undeclared" | "unsupported"
+// mobile permissions must be declared in everywhere.yml (camera/location
+// declarations carry the usage string iOS shows) — undeclared never prompts
+
+Everywhere.storage.get("key")        // Promise<any | null> — device-local settings
+Everywhere.storage.set("key", value) // Promise<boolean>; any JSON value round-trips
+Everywhere.storage.remove("key")     // Promise<boolean>
+Everywhere.storage.clear()           // Promise<boolean> — clears app keys only
+// UserDefaults in the mobile shell (survives web view resets and cache
+// clears, unlike localStorage); localStorage-backed in browsers and the
+// desktop shell. Settings, not secrets — tokens go in biometrics.credential.
+```
+
+### Native chrome (nav bar buttons, menus, action sheets)
+
+Tag ordinary markup, and inside the mobile shell the bridge lifts it into real
+native controls — a nav-bar button, a pull-down / overflow menu, or an action
+sheet. Tapping the native control just `.click()`s the element it mirrors, so a
+link navigates, a submit submits, and behavior stays defined once in the DOM. In
+a browser the same markup is the plain HTML it already is. No JavaScript, no
+Stimulus — CSP-safe.
+
+```html
+<!-- becomes a nav-bar button (right side); icons are per-platform like tabs -->
+<a href="/notes/new" data-everywhere-nav-button
+   data-everywhere-nav-title="New"
+   data-everywhere-nav-icon-ios="plus"
+   data-everywhere-nav-icon-android="add">New</a>
+
+<!-- a submit button in the nav bar -->
+<button type="submit" data-everywhere-nav-button
+        data-everywhere-nav-title="Save" data-everywhere-nav-style="done">Save</button>
+
+<!-- a nav-bar pull-down / overflow menu (defaults to the ⋯ icon) -->
+<div data-everywhere-nav-menu data-everywhere-nav-title="More">
+  <a href="/share" data-everywhere-menu-item data-everywhere-menu-title="Share">Share</a>
+  <button form="delete_1" data-everywhere-menu-item
+          data-everywhere-menu-title="Delete"
+          data-everywhere-menu-style="destructive">Delete</button>
+</div>
+
+<!-- an in-content action sheet: a trigger and the items it opens -->
+<div data-everywhere-menu>
+  <button data-everywhere-menu-trigger>Options</button>
+  <div data-everywhere-menu-items>
+    <a href="/x/edit" data-everywhere-menu-item>Edit</a>
+  </div>
+</div>
+```
+
+Rails ships helpers that emit exactly this — `everywhere_nav_button`,
+`everywhere_submit_button`, `everywhere_nav_menu` / `everywhere_menu_item`,
+`everywhere_menu`, and `everywhere_fab` (a floating action button). Include
+`everywhere/native.css` for the FAB, the action-sheet fallback, and the
+safe-area utilities.
+
+### Multi-instance apps
+
+Apps whose users pick a server — one hosted platform, many instances — opt in
+with `remote.instances: true` in `everywhere.yml`. The mobile shell then boots
+into `remote.url` (your hosted picker page) until that page picks an instance:
+
+```js
+Everywhere.instance.supported        // true in a shell built with remote.instances
+Everywhere.instance.current          // active instance URL, or null (= built-in root)
+
+Everywhere.instance.set("https://acme.example.com")
+// validates, persists, and fully resets the app onto the instance — every
+// later launch boots straight there. {to: "/path"} lands somewhere specific.
+
+Everywhere.instance.clear()          // back to the picker (and resets again)
 ```
 
+In a plain browser `set()` simply navigates to the URL — going there is what
+picking an instance means on the web.
+
+Declarative forms need no JS: elements with `data-everywhere-haptic`
+(`"light"`, `"impact:heavy"`, `"notification:error"`, `"selection"`) play on
+tap, and `<meta name="everywhere:badge">` / `<meta name="everywhere:tab-badge">`
+tags (the `everywhere_badge` / `everywhere_tab_badge` Rails helpers) are
+applied on every Turbo visit.
+
 ### Auto-updates
 
 Inside the desktop shell, apps with an update feed configured can check,
@@ -69,8 +167,13 @@ In a plain browser tab the updates API is inert: `check()` resolves
   clipboard, shell events, and auto-updates are native.
 - **browser** — honest web fallbacks: the Notification API, `window.confirm`,
   `navigator.clipboard`, DOM CustomEvents.
-- **mobile** — Hotwire Native detection is live; behavior currently falls back
-  to the browser adapter until the bridge-component adapter lands.
+- **mobile** — Hotwire Native (iOS shell). `notify()` delivers a native local
+  notification via the shell's `everywhere--notification` bridge component
+  (web-bridge handshake is installed automatically unless the app already
+  loads `@hotwired/hotwire-native-bridge` — first one wins, like the official
+  package). `confirm()`/clipboard use the browser fallbacks, which are native
+  in a WKWebView anyway. Everything degrades to browser behavior outside the
+  shell.
 
 ## License