genesys-spark-components 4.0.0-beta.8 → 4.0.1

package/README.md

@@ -1,6 +1,11 @@
+# Genesys Spark Monorepo
+
 # Spark Web Components
 
-This repo contains the CSS and custom elements that make up Genesys' design system, [Spark](https://spark.genesys.com).
+This repo contains the custom elements that make up the bulk of the
+[Spark](https://spark.genesys.com) design system. Developers should prefer using
+the [`genesys-spark`](../genesys-spark/README.md) package and avoid importing
+this package directly unless there is a specific reason to do so.
 
 ## Component Evolution
 
@@ -10,11 +15,12 @@ At any given time there are three types of components present in the library:
 - **beta**: New components where the API design is still being explored. Breaking changes _may_ happen without a major version change.
 - **legacy**: Old components that have been replaced by a new component, or a newer version of the component with an incompatible API. These will be removed in the next major release.
 
-For more details on the component evolution process see the full [documentation on the topic](./documentation/COMPONENT_EVOLUTION.md)
+For more details on the component evolution process see the full [documentation on the topic](./packages/genesys-spark-components/documentation/COMPONENT_EVOLUTION.md)
 
 ## Demo/Documentation
 
-[Lives here](https://apps.inindca.com/common-ui-docs/#/genesys-webcomponents/latest)
+You can find usage examples of all of the components, with an in-browser editor playground
+online [here](https://apps.inindca.com/common-ui-docs/#/genesys-webcomponents/latest).
 
 ## Installing the library
 
@@ -28,10 +34,12 @@ or
 
 ## Setting up your App
 
-### Configuration
+### Required Fonts
 
-Since version 3, you will need to set the "allowSyntheticDefaultImports" compiler option to "true" in your host apps tsconfig.json. Omitting this option will cause build errors in your app.
-This new requirement is related to a new dependency (vega-lite) which was added as part of our visualisation work.
+Spark is designed to work with the Urbanist and Noto Sans fonts. These components
+do not provide font loading, so you must include them separately in your project.
+For a detailed breakdown of the variants of each font in use, see the typography
+section of the [Spark Design Docs](https://spark.genesys.com).
 
 ### Stylesheets
 
@@ -47,19 +55,6 @@ The best mechanism for importing the stylesheet into your project will depend on
 
 **Note: Since v3 this baseline stylesheet is required.**
 
-#### Contextual z-index overrides
-
-In complex layouts you may find that your app's use of `z-index` conflicts with the default `z-index` applied to raised content like dropdown menus, tooltips, popovers, or modals.
-
-Components with layered content elements like menus or popovers use CSS variables for their `z-index`, and you can override the default z-index in your app's stylesheet for the specific context where you have a conflict.
-
-```css
-.myApp .someElementThatHasContentWithCustomZIndexes {
-  /* Provide higher z-index for dropdowns in this part of my app so they appear above the surrounding content */
-  --gux-zindex-popup: 100;
-}
-```
-
 ### Genesys Cloud applications
 
 Genesys Cloud applications, or other always-online apps should import the library and call
@@ -82,7 +77,7 @@ and the components will localize based on that. If no language is set, the compo
 
 ### Framework Integration Notes
 
-- [React](./documentation/REACT_INTEGRATION.md)
+- [React](./packages/genesys-spark-components/documentation/REACT_INTEGRATION.md)
 
 ## Development and Contribution
 
@@ -91,7 +86,7 @@ contribution from users is welcome. If you need a new feature, the best way to g
 with the team to implement it yourself. Please reach out to discuss your work _before_ opening a PR.
 An early conversation is the best way to avoid duplicated effort.
 
-Also, be sure to read the [Contributing Guidelines](./documentation/CONTRIBUTING.md) before starting development work.
+Also, be sure to read the [Contributing Guidelines](./packages/genesys-spark-components/documentation/CONTRIBUTING.md) before starting development work.
 
 ### Serving component and docs
 

package/dist/cjs/find-element-by-id-9c3e0b1b.js

@@ -0,0 +1,26 @@
+'use strict';
+
+function getContainingDocument(node) {
+  if (node.nodeType === Node.DOCUMENT_NODE) {
+    return node;
+  }
+  if (node.nodeType === Node.DOCUMENT_FRAGMENT_NODE) {
+    return node;
+  }
+  return node.ownerDocument;
+}
+function findElementById(root, forElementId) {
+  let priorRoot = null;
+  let rootNode = root.getRootNode();
+  let forElement;
+  while (rootNode && rootNode !== priorRoot && !forElement) {
+    const doc = getContainingDocument(rootNode);
+    forElement = doc === null || doc === void 0 ? void 0 : doc.getElementById(forElementId);
+    // Keep track of the prior root to stop if a node returns itself as its root
+    priorRoot = rootNode;
+    rootNode = rootNode.getRootNode();
+  }
+  return forElement;
+}
+
+exports.findElementById = findElementById;