@openreceive/elements 0.1.1 → 0.2.2

package/README.md

@@ -0,0 +1,35 @@
+# @openreceive/elements
+
+The OpenReceive checkout custom element (`<openreceive-checkout>`) and theme toggle (`<openreceive-theme-toggle>`).
+
+## Mount
+
+```js
+import { defineElements } from "@openreceive/elements";
+import "@openreceive/elements/styles.css";
+
+// Registers <openreceive-checkout> and <openreceive-theme-toggle> with the
+// browser. Until this runs, those tags are unknown markup and render as
+// nothing; once it runs, every such tag on the page — already in the HTML or
+// added later — becomes the live checkout UI. Call once per page.
+defineElements();
+```
+
+```html
+<openreceive-checkout reference="order-123"></openreceive-checkout>
+```
+
+The element creates the checkout for `reference`, then renders and polls itself.
+It dispatches plain DOM `CustomEvent`s (`openreceive-settled`,
+`openreceive-error`, …); the Vue/Svelte/Angular wrapper packages expose those as
+handler props over the shared binding at
+`@openreceive/elements/wrapper-shared`.
+
+## Icon assets
+
+The checkout loads its payment-method icons by URL at runtime; your app must
+serve them where the resolution lands. See
+[Icon assets in `@openreceive/browser`](https://github.com/openreceive/openreceive/blob/master/packages/js/browser/README.md#icon-assets)
+for the per-bundler recipes.
+
+Part of [OpenReceive](https://openreceive.org). Start with the [Node quickstart](https://github.com/openreceive/openreceive/blob/master/docs/guides/quickstart-node.md); the full API is in the [API reference](https://github.com/openreceive/openreceive/blob/master/docs/guides/api-reference.md).