brut-js 0.0.11 → 0.0.21

package/src/AjaxSubmit.js

@@ -4,7 +4,7 @@ import ConstraintViolationMessage from "./ConstraintViolationMessage"
 
 /** Wraps a `<BUTTON>` assumed to be inside a form to indicate that, when clicked, it should submit
  * the form it's a part of via AJAX. It accounts for network failures and timeouts.
- * 
+ *
  * The general flow is as follows:
  *
  * 1. When the button is clicked, the form's validity is checked. If it's not valid, nothing happens.
@@ -55,6 +55,8 @@ import ConstraintViolationMessage from "./ConstraintViolationMessage"
  *     <button>Save</button>
 *    </brut-ajax-submit>
  * </form>
+ *
+ * @customelement brut-ajax-submit
  */
 class AjaxSubmit extends BaseCustomElement {
   static tagName = "brut-ajax-submit"

package/src/Autosubmit.js

@@ -19,6 +19,8 @@ import BaseCustomElement from "./BaseCustomElement"
  *   <input type="text" value="notes">
  *   <button>Save</button>
  * </form>
+ *
+ * @customElement brut-autosubmit
  */
 class Autosubmit extends BaseCustomElement {
   static tagName = "brut-autosubmit"

package/src/ConfirmSubmit.js

@@ -25,6 +25,8 @@ import ConfirmationDialog from "./ConfirmationDialog"
  * @property {string} dialog - optional ID of the `brut-confirmation-dialog` to use instead of `window.confirm`.
  *                             If there is no such dialog or the id references the wrong element type,
  *                             `window.confirm` will be used.  Setting `show-warnings` will generate a warning for this.
+ *
+ * @customElement brut-confirm-submit
  */
 class ConfirmSubmit extends BaseCustomElement {
   static tagName = "brut-confirm-submit"

package/src/ConfirmationDialog.js

@@ -26,6 +26,8 @@ import RichString from "./RichString"
  *     <button value="cancel">Nevermind</button>
  *   </dialog>
  * </brut-confirmation-dialog>
+ *
+ * @customElement brut-confirmation-dialog
  */
 class ConfirmationDialog extends BaseCustomElement {
   static tagName = "brut-confirmation-dialog"

package/src/ConstraintViolationMessage.js

@@ -7,9 +7,9 @@ import I18nTranslation from "./I18nTranslation"
  *
  * Here is how the field's name is determined:
  *
- * 1. It will look for a `<brut-i18n-translation>` element with the `key` `general.cv.fe.fieldNames.«input-name»`.
+ * 1. It will look for a `<brut-i18n-translation>` element with the `key` `cv.fe.fieldNames.«input-name»`.
  * 2. If that's not found, it will attempt to use "this field" by locating a `<brut-i18n-translation>` element with the `key`
- *    `general.cv.this_field` (the underscore being what is used on Brut's server side).
+ *    `cv.this_field` (the underscore being what is used on Brut's server side).
  * 3. If that is not found, it will use the literaly string "this field" and emit a console warning.
  *
  * @property {string} key - the i18n translation key to use.  It must map to the `key` of a `<brut-i18n-translation>` on the page or
@@ -22,6 +22,8 @@ import I18nTranslation from "./I18nTranslation"
  * @see I18nTranslation
  * @see ConstraintViolationMessages
  * @see Message
+ *
+ * @customElement brut-cv
  */
 class ConstraintViolationMessage extends BaseCustomElement {
   static tagName = "brut-cv"
@@ -64,7 +66,7 @@ class ConstraintViolationMessage extends BaseCustomElement {
    * @param {...String} keyPath - parts of the path of the key after the namespace that Brut manages.
    */
   static i18nKey(...keyPath) {
-    const path = [ "general", "cv" ]
+    const path = [ "cv" ]
     return path.concat(keyPath).join(".")
   }
 

package/src/ConstraintViolationMessages.js

@@ -17,6 +17,8 @@ import ConstraintViolationMessage from "./ConstraintViolationMessage"
  * @see Form
  * @see ConstraintViolationMessage
  * @see AjaxSubmit
+ *
+ * @customElement brut-cv-messages
  */
 class ConstraintViolationMessages extends BaseCustomElement {
   static tagName = "brut-cv-messages"
@@ -36,7 +38,7 @@ class ConstraintViolationMessages extends BaseCustomElement {
    * This should be called as part of a Form validation event to provide a customized UX for
    * the error messages, beyond what the browser would do by default.  The keys used are the same
    * as the attributes of a `ValidityState`, so for example, a range underflow would mean that `validity.rangeUnderflow` would return
-   * true.  Thus, a `<brut-cv>` would be created with `key="general.cv.fe.rangeUnderflow"`.
+   * true.  Thus, a `<brut-cv>` would be created with `key="cv.fe.rangeUnderflow"`.
    *
    * The `cv.fe` is hard-coded to be consistent with Brut's server-side translation management.
    *

package/src/CopyToClipboard.js

@@ -31,6 +31,8 @@ import BaseCustomElement from "./BaseCustomElement"
  * <brut-copy-to-clipboard element="code">
  *   <button>Copy</button>
  * </brut-copy-to-clipboard>
+ *
+ * @customElement brut-copy-to-clipboard
  */
 class CopyToClipboard extends BaseCustomElement {
   static tagName = "brut-copy-to-clipboard"

package/src/Form.js

@@ -61,6 +61,8 @@ import ConstraintViolationMessages from "./ConstraintViolationMessages"
  *
  * @property {boolean} submitted-invalid - set by this element when the form is submitted. Does not trigger any behavior and can be used in CSS.
  * @see ConstraintViolationMessages
+ *
+ * @customElement brut-form
  */
 class Form extends BaseCustomElement {
   static tagName = "brut-form"

package/src/I18nTranslation.js

@@ -12,6 +12,8 @@ import BaseCustomElement from "./BaseCustomElement"
  *
  * @example
  * <brut-i18n-translation key="greeting" value="Hello %{username}"></brut-i18n-translation>
+ *
+ * @customElement brut-i18n-translation
  */
 class I18nTranslation extends BaseCustomElement {
   static tagName = "brut-i18n-translation"

package/src/LocaleDetection.js

@@ -1,5 +1,29 @@
 import BaseCustomElement from "./BaseCustomElement"
 
+/**
+ * Send the locale and timezone from the browser to a configured endpoint on the server. This allows
+ * the server to have access to a reasonable guess as to the website visitor's locale/timezone.
+ *
+ * Note that this will not contact the server if both `locale-from-server` and `timezone-from-server` are
+ * set.  Further note that this will only contact the server once per page load, unless `url` is changed.
+ *
+ * @property {String} locale-from-server - omit this if the server doesn't know the visitor's locale. If both this and `timezone-from-server` are set, the server will not be contacted.
+ * @property {String} timezone-from-server - omit this if the server doesn't know the visitor's timezone. If both this and `locale-from-server` are set, the server will not be contacted.
+ * @property {URL} url - the url to send information to on the server.
+ * @property {number} timeout-before-ping-ms - MS to wait until this element contacts the server. A value of 0 will contact the server immediately. The default is 1,000, meaning this element will wait 1 second before contacting the server.
+ *
+ * @example <caption>When no information about the visitor is known</caption>
+ * <brut-locale-detection url="__brut/locale-detection"></brut-locale-detection>
+ *
+ * @example <caption>When all information about the visitor is known</caption>
+ * <brut-locale-detection
+ *   url="__brut/locale-detection"
+ *   locale-from-server="en-US"
+ *   timezone-from-server="America/New_York">
+ * </brut-locale-detection>
+ *
+ * @customElement brut-locale-detection
+ */
 class LocaleDetection extends BaseCustomElement {
   static tagName = "brut-locale-detection"
 

package/src/Message.js

@@ -13,10 +13,11 @@ import I18nTranslation from "./I18nTranslation"
  *
  * @see I18nTranslation
  * @see ConstraintViolationMessage
+ *
+ * @customElement brut-message
  */
 class Message extends BaseCustomElement {
   static tagName = "brut-message"
-
   static observedAttributes = [
     "show-warnings",
     "key",
@@ -50,6 +51,6 @@ class Message extends BaseCustomElement {
 
     this.textContent = RichString.fromString(translation.translation()).capitalize().toString()
   }
-
 }
+
 export default Message

package/src/Tabs.js

@@ -69,6 +69,7 @@ import BaseCustomElement from "./BaseCustomElement"
  *   <h3>Spam</h3>
  * </section>
  *
+ * @customElement brut-tabs
  */
 class Tabs extends BaseCustomElement {
   static tagName = "brut-tabs"

package/src/Tracing.js

@@ -59,6 +59,8 @@ import { BaseCustomElement } from "brut-js"
  *
  * @see {@link https://www.w3.org/TR/trace-context/}
  * @see external:Performance
+ *
+ * @customElement brut-tracing
  */
 class Tracing extends BaseCustomElement {
   static tagName = "brut-tracing"

package/src/index.js

@@ -127,3 +127,4 @@ export {
   Tabs,
   Tracing
 }
+

package/CODE_OF_CONDUCT.txt

@@ -1,99 +0,0 @@
-Contributor Covenant Code of Conduct
-
-Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-Our Standards
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others’ private information, such as a physical or email address,
-without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-professional setting
-
-Enforcement Responsibilities
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-Scope
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official email address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-Enforcement
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[INSERT CONTACT METHOD].
-All complaints will be reviewed and investigated promptly and fairly.
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-Enforcement Guidelines
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-1. Correction
-Community Impact: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-Consequence: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-2. Warning
-Community Impact: A violation through a single incident or series of
-actions.
-Consequence: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-3. Temporary Ban
-Community Impact: A serious violation of community standards, including
-sustained inappropriate behavior.
-Consequence: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-4. Permanent Ban
-Community Impact: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-Consequence: A permanent ban from any sort of public interaction within the
-community.
-Attribution
-This Code of Conduct is adapted from the Contributor Covenant,
-version 2.1, available at
-https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
-Community Impact Guidelines were inspired by
-Mozilla’s code of conduct enforcement ladder.
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
-