npm - @cdc/markup-include - Versions diffs - 1.0.0 → 1.0.1 - Mend

@cdc/markup-include 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md +7 -12
package/dist/cdcmarkupinclude.js +2 -2
package/examples/test.html +1 -0
package/package.json +10 -10
package/src/CdcMarkupInclude.jsx +47 -18
package/src/components/EditorPanel.js +55 -60
package/src/data/initial-state.js +8 -1
package/src/index.js +11 -7
package/src/scss/main.scss +13 -2
package/src/scss/_variables.scss +0 -29

package/examples/test.html ADDED Viewed

@@ -0,0 +1 @@

+ <!doctype html><html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>Document</title> </head> <body> <h1>Header</h1> <p>Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p> <br> <p>Even the all-powerful Pointing has no control about the blind texts it is an almost unorthographic life One day however a small line of blind text by the name of Lorem Ipsum decided to leave for the far World of Grammar. The Big Oxmox advised her not to do so, because there were thousands of bad Commas, wild Question Marks and devious Semikoli, but the Little Blind Text didn’t listen. </p><br><p>She packed her seven versalia, put her initial into the belt and made herself on the way. When she reached the first hills of the Italic Mountains, she had a last view back on the skyline of her hometown Bookmarksgrove, the headline of Alphabet Village and the subline of her own road, the Line Lane. Pityful a rethoric question ran over her cheek.</p></body></html>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@cdc/markup-include",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "React component for displaying HTML content from an outside link",
   "main": "dist/cdcmarkupinclude",
   "scripts": {
@@ -19,21 +19,21 @@
   },
   "license": "Apache-2.0",
   "homepage": "https://github.com/CDCgov/cdc-open-viz#readme",
-  "devDependencies": {
-    "@cdc/core": "^1.1.2",
-    "interweave": "^13.0.0",
-    "react-accessible-accordion": "^3.3.4",
-    "use-debounce": "^6.0.1"
-  },
   "dependencies": {
+    "@cdc/core": "^1.1.3",
     "axios": "^0.26.1",
     "chroma": "0.0.1",
     "chroma-js": "^2.1.0",
-    "html-react-parser": "^1.4.8"
+    "html-react-parser": "1.4.9",
+    "interweave": "^13.0.0",
+    "react-accessible-accordion": "^3.3.4"
   },
   "peerDependencies": {
     "react": "^17.0.2",
-    "react-dom": ">=16"
+    "react-dom": "^17.0.2"
+  },
+  "resolutions": {
+    "@types/react": "17.x"
   },
-  "gitHead": "7b505fcc2ba71d8ee9beadc7fdf7aed769e58644"
+  "gitHead": "ff89a7aea74c533413c62ef8859cc011e6b3cbfa"
 }

package/src/CdcMarkupInclude.jsx CHANGED Viewed

@@ -1,4 +1,4 @@
-import React, { useEffect, useCallback, useState } from 'react'
+import React, { useEffect, useCallback, useState, useRef } from 'react'
 import axios from 'axios'
 import parse from 'html-react-parser'
 import { Markup } from 'interweave'
@@ -9,8 +9,11 @@ import Loading from '@cdc/core/components/Loading'
 import ConfigContext from './ConfigContext'
 import EditorPanel from './components/EditorPanel'
 import defaults from './data/initial-state'
 import './scss/main.scss'
+import { publish } from '@cdc/core/helpers/events';
 const CdcMarkupInclude = (
   {
     configUrl,
@@ -29,6 +32,21 @@ const CdcMarkupInclude = (
   const [ urlMarkup, setUrlMarkup ] = useState('')
   const [ markupError, setMarkupError ] = useState(null)
   const [ errorMessage, setErrorMessage ] = useState(null)
+  const [ coveLoadedHasRan, setCoveLoadedHasRan ] = useState(false)
+  const container = useRef();
+  let innerContainerClasses = ['cove-component__inner']
+  config.title && innerContainerClasses.push('component--has-title')
+  config.subtext && innerContainerClasses.push('component--has-subtext')
+  config.biteStyle && innerContainerClasses.push(`bite__style--${config.biteStyle}`)
+  config.general?.isCompactStyle && innerContainerClasses.push(`component--isCompactStyle`)
+  let contentClasses = ['cove-component__content'];
+  !config.visual?.border && contentClasses.push('no-borders');
+  config.visual?.borderColorTheme && contentClasses.push('component--has-borderColorTheme');
+  config.visual?.accent && contentClasses.push('component--has-accent');
+  config.visual?.background && contentClasses.push('component--has-background');
+  config.visual?.hideBackgroundColor && contentClasses.push('component--hideBackgroundColor');
   let {
     title
@@ -64,7 +82,6 @@ const CdcMarkupInclude = (
     setLoading(false)
   }, [])
   // Custom Functions
   useEffect(() => {
     if (markupError) {
@@ -94,7 +111,7 @@ const CdcMarkupInclude = (
     if (config.srcUrl) {
       if (config.srcUrl === '#example') {
-        setUrlMarkup('<!doctype html><html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>Document</title> </head> <body> <h1>Header</h1> <p> But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. </p><br/><p> No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. </p><br/><p> To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?</p></body></html>')
+        setUrlMarkup('<!doctype html><html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <title>Document</title> </head> <body> <h1>Header</h1> <p>Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia. It is a paradisematic country, in which roasted parts of sentences fly into your mouth.</p> <br> <p>Even the all-powerful Pointing has no control about the blind texts it is an almost unorthographic life One day however a small line of blind text by the name of Lorem Ipsum decided to leave for the far World of Grammar. The Big Oxmox advised her not to do so, because there were thousands of bad Commas, wild Question Marks and devious Semikoli, but the Little Blind Text didn’t listen. </p><br><p>She packed her seven versalia, put her initial into the belt and made herself on the way. When she reached the first hills of the Italic Mountains, she had a last view back on the skyline of her hometown Bookmarksgrove, the headline of Alphabet Village and the subline of her own road, the Line Lane. Pityful a rethoric question ran over her cheek.</p></body></html>')
       } else {
         try {
           await axios
@@ -139,8 +156,16 @@ const CdcMarkupInclude = (
   //Load initial config
   useEffect(() => {
     loadConfig().catch((err) => console.log(err))
+    publish('cove_loaded', { loadConfigHasRun: true })
   }, [])
+  useEffect(() => {
+    if (config && !coveLoadedHasRan && container) {
+      publish('cove_loaded', { config: config })
+      setCoveLoadedHasRan(true)
+    }
+  }, [config, container]);
   //Reload config if config object provided/updated
   useEffect(() => {
     loadConfig().catch((err) => console.log(err))
@@ -153,29 +178,33 @@ const CdcMarkupInclude = (
   let content = (<Loading/>)
+  let bodyClasses = [
+    'markup-include',
+  ]
   if (loading === false) {
     let body = (
-      <>
-        <div className="cove-component markup-include">
-          {title &&
-          <header className={`cove-component__header ${config.theme}`} aria-hidden="true">
-            {parse(title)} {isDashboard}
-          </header>
-          }
-          <div className="cove-component__content">
-            {!markupError && urlMarkup &&
+      <div className={ bodyClasses.join(' ')} ref={container}>
+      {title &&
+        <header className={`cove-component__header ${config.theme}`} aria-hidden="true">
+        {parse(title)} {isDashboard}
+        </header>
+      }
+      <div className={`cove-component__content ${contentClasses.join(' ')}`}>
+        <div className={`${innerContainerClasses.join(' ')}`}>
             <div className="cove-component__content-wrap">
-              <Markup content={parseBodyMarkup(urlMarkup)}/>
+              {!markupError && urlMarkup &&
+                <Markup content={parseBodyMarkup(urlMarkup)}/>
+              }
+              {markupError && config.srcUrl && <div className="warning">{errorMessage}</div>}
             </div>
-            }
-            {markupError && config.srcUrl && <div className="warning">{errorMessage}</div>}
           </div>
-        </div>
-      </>
+      </div>
+    </div>
     )
     content = (
-      <div className={`cove`} style={isDashboard ? { marginTop: '3rem' } : null}>
+      <div className={`cove markup-include ${config.theme}`}>
         {isEditor && <EditorPanel>{body}</EditorPanel>}
         {!isEditor && body}
       </div>

package/src/components/EditorPanel.js CHANGED Viewed

@@ -1,17 +1,13 @@
 import React, { useState, useEffect, memo, useContext } from 'react'
-import {
-  Accordion,
-  AccordionItem,
-  AccordionItemHeading,
-  AccordionItemPanel,
-  AccordionItemButton,
-} from 'react-accessible-accordion'
+import ErrorBoundary from '@cdc/core/components/ErrorBoundary'
 import ConfigContext from '../ConfigContext'
-import ErrorBoundary from '@cdc/core/components/ErrorBoundary'
-import InputText from '@cdc/core/components/input/InputText'
+import Accordion from '@cdc/core/components/ui/Accordion'
+import InputText from '@cdc/core/components/inputs/InputText'
+import '@cdc/core/styles/v2/components/editor.scss'
 const headerColors = [ 'theme-blue', 'theme-purple', 'theme-brown', 'theme-teal', 'theme-pink', 'theme-orange', 'theme-slate', 'theme-indigo', 'theme-cyan', 'theme-green', 'theme-amber' ]
@@ -26,7 +22,8 @@ const EditorPanel = memo((props) => {
   } = useContext(ConfigContext)
   const [ displayPanel, setDisplayPanel ] = useState(true)
-  const [ showConfigConfirm, setShowConfigConfirm ] = useState(true)
+  const [ showConfigConfirm, setShowConfigConfirm ] = useState(false)
   const updateField = (section, subsection, fieldName, newValue) => {
     // Top level
@@ -72,7 +69,6 @@ const EditorPanel = memo((props) => {
       setParentConfig(newConfig)
     }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [ config ])
   useEffect(()=> {
@@ -117,7 +113,7 @@ const EditorPanel = memo((props) => {
         <section className="waiting-container">
           <h3>Finish Configuring</h3>
           <p>Set all required options to the left and confirm below to display a preview of the markup.</p>
-          <button className="btn" style={{ margin: '1em auto' }} disabled={missingRequiredSections()}
+          <button className="btn" style={{ margin: '1em auto' }}
                   onClick={confirmDone}>I'm Done
           </button>
         </section>
@@ -127,17 +123,56 @@ const EditorPanel = memo((props) => {
   const convertStateToConfig = () => {
     let strippedState = JSON.parse(JSON.stringify(config))
-    if (false === missingRequiredSections()) {
-      delete strippedState.newViz
-    }
+    delete strippedState.newViz
     delete strippedState.runtime
     return strippedState
   }
-  if (loading) {
-    return null
-  }
+  const CheckBox = memo(({ label, value, fieldName, section = null, subsection = null, tooltip, updateField, ...attributes }) => (
+    <label className="checkbox">
+      <input type="checkbox" name={fieldName} checked={value} onChange={() => { updateField(section, subsection, fieldName, !value) }} {...attributes} />
+      <span className="edit-label column-heading">{label}</span><span className="cove-icon">{tooltip}</span>
+    </label>
+  ))
+  const editorContent = (
+    <Accordion>
+      <Accordion.Section title="General">
+        <InputText value={config.title || ''} fieldName="title" label="Title"
+                   placeholder="Markup Include Title"
+                   updateField={updateField}/>
+        <InputText
+          value={config.srcUrl || ''} fieldName="srcUrl" label="Source URL"
+          placeholder="https://www.example.com/file.html" updateField={updateField}
+        />
+      </Accordion.Section>
+      <Accordion.Section title="Visual">
+        <div className="input-group">
+          <label>Theme</label>
+          <ul className="color-palette">
+            {headerColors.map((palette) => (
+              <li title={palette} key={palette} onClick={() => {
+                updateConfig({ ...config, theme: palette })
+              }} className={config.theme === palette ? 'selected ' + palette : palette}>
+              </li>
+            ))}
+          </ul>
+        </div>
+        {/* <div className="cove-accordion__panel-section">
+          <CheckBox value={config.visual.border} section="visual" fieldName="border" label="Display Border" updateField={updateField} />
+          <CheckBox value={config.visual.borderColorTheme} section="visual" fieldName="borderColorTheme" label="Use Border Color Theme" updateField={updateField} />
+          <CheckBox value={config.visual.accent} section="visual" fieldName="accent" label="Use Accent Style" updateField={updateField} />
+          <CheckBox value={config.visual.background} section="visual" fieldName="background" label="Use Theme Background Color" updateField={updateField} />
+          <CheckBox value={config.visual.hideBackgroundColor} section="visual" fieldName="hideBackgroundColor" label="Hide Background Color" updateField={updateField} />
+        </div> */}
+      </Accordion.Section>
+    </Accordion>
+  )
+  if (loading) return null
   return (
     <ErrorBoundary component="EditorPanel">
@@ -149,48 +184,8 @@ const EditorPanel = memo((props) => {
         <section className={`cove-editor__panel` + (displayPanel ? `` : ' hidden')}>
           <div className="cove-editor__panel-container">
             <h2 className="cove-editor__heading">Configure Markup Include</h2>
-            <section className="form-container">
-              <form>
-                <Accordion allowZeroExpanded={true}>
-                  <AccordionItem> {/* General */}
-                    <AccordionItemHeading>
-                      <AccordionItemButton>
-                        General
-                      </AccordionItemButton>
-                    </AccordionItemHeading>
-                    <AccordionItemPanel>
-                      <InputText value={config.title || ''} fieldName="title" label="Title"
-                                 placeholder="Markup Include Title"
-                                 updateField={updateField}/>
-                      <InputText
-                        value={config.srcUrl || ''} fieldName="srcUrl" label="Source URL"
-                        placeholder="https://www.example.com/file.html" updateField={updateField}
-                      />
-                    </AccordionItemPanel>
-                  </AccordionItem>
-                  <AccordionItem>
-                    <AccordionItemHeading>
-                      <AccordionItemButton>
-                        Visual
-                      </AccordionItemButton>
-                    </AccordionItemHeading>
-                    <AccordionItemPanel>
-                      <div className="input-group">
-                        <label>Theme</label>
-                        <ul className="color-palette">
-                          {headerColors.map((palette) => (
-                            <li title={palette} key={palette} onClick={() => {
-                              updateConfig({ ...config, theme: palette })
-                            }} className={config.theme === palette ? 'selected ' + palette : palette}>
-                            </li>
-                          ))}
-                        </ul>
-                      </div>
-                    </AccordionItemPanel>
-                  </AccordionItem>
-                </Accordion>
-              </form>
+            <section className="cove-editor__content">
+              {editorContent}
             </section>
           </div>
         </section>

package/src/data/initial-state.js CHANGED Viewed

@@ -3,5 +3,12 @@ export default {
   "showHeader": false,
   "type": "markup-include",
   "srcUrl": "#example",
-  "theme": "theme-blue"
+  "theme": "theme-blue",
+  "visual": {
+    "border": false,
+    "accent": false,
+    "background": false,
+    "hideBackgroundColor": false,
+    "borderColorTheme": false
+  },
 }

package/src/index.js CHANGED Viewed

@@ -1,16 +1,20 @@
-import React from 'react';
-import { render } from 'react-dom';
+import React from 'react'
+import { render } from 'react-dom'
+import { GlobalContextProvider } from '@cdc/core/components/GlobalContext'
 import CdcMarkupInclude from './CdcMarkupInclude'
-const domContainers = document.querySelectorAll('.react-container');
+const domContainers = document.querySelectorAll('.react-container')
-let isEditor = window.location.href.includes('editor=true');
+let isEditor = window.location.href.includes('editor=true')
 domContainers.forEach((domContainer) => {
   render(
     <React.StrictMode>
-      <CdcMarkupInclude configUrl={domContainer.attributes['data-config'].value} isEditor={isEditor} />
+      <GlobalContextProvider>
+        <CdcMarkupInclude configUrl={domContainer.attributes['data-config'].value} isEditor={isEditor}/>
+      </GlobalContextProvider>
     </React.StrictMode>,
     domContainer
-  );
-});
+  )
+})

package/src/scss/main.scss CHANGED Viewed

@@ -1,5 +1,16 @@
 @import '~@cdc/core/styles/v2/main';
-html,body {
-  margin: 0;
+.markup-include {
+  .cove-component__header {
+    font-size: unset;
+  }
+  .cove-component__content {
+    background-color: #f2f2f2;
+    font-size: 14px;
+  }
+  .cove-component__content.component--hideBackgroundColor {
+    background: transparent;
+  }
 }

package/src/scss/_variables.scss DELETED Viewed

@@ -1,29 +0,0 @@
-$theme-colors: (
-  "blue": $primary,
-  "purple": $purple-primary,
-  "brown": $brown-primary,
-  "teal": $teal-primary,
-  "pink": $pink-primary,
-  "orange": $orange-primary,
-  "slate": $slate-primary,
-  "indigo": $indigo-primary,
-  "cyan": $cyan-primary,
-  "green": $green-primary,
-  "amber": $amber-primary
-);
-$theme-colors-secondary: (
-  "blue": $secondary,
-  "purple": $purple-secondary,
-  "brown": $brown-secondary,
-  "teal": $teal-secondary,
-  "pink": $pink-secondary,
-  "orange": $orange-secondary,
-  "slate": $slate-secondary,
-  "indigo": $indigo-secondary,
-  "cyan": $cyan-secondary,
-  "green": $green-secondary,
-  "amber": $amber-secondary
-);
-$editorWidth: 350px;