@mjhls/mjh-framework 1.0.99-0.next12 → 1.0.99

package/README.md

@@ -1,168 +1,172 @@
-# mjh-framework v. 1.0.988
-
-[![NPM](https://img.shields.io/npm/v/mjh-framework.svg)](https://www.npmjs.com/package/mjh-framework) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
-
-## Install
-
-```bash
-npm install --save @mjhls/mjh-framework
-```
-
-## Usage
-
-```jsx
-import React, { Component } from 'react'
-
-import { NavMagazine, DeckQueue } from 'mjh-framework'
-
-export default class App extends Component {
-  render() {
-    return (
-      <div>
-        <NavMagazine />
-        <DeckQueue />
-      </div>
-    )
-  }
-}
-```
-
-## Publish new updates to the npm registry
-
-```bash
-npm publish
-```
-
-## For getting updates in the template without publishing each time a change is made in the framework
-
-Link react and react-dom of the template repo, so that it can be used by the framework.
-This is to avoid the error arising due to multiple instances of React.
-
-```bash
-cd ../mjh-template/node_modules/react
-
-yarn link
-
-cd ../react-dom
-
-yarn link
-
-cd ../../../mjh-framework
-
-yarn link react && yarn link react-dom
-```
-
-Link the framework repo so that it can be used in the template
-
-```bash
-npm link
-
-cd ../mjh-template
-
-npm link @mjhls/mjh-framework
-```
-
-## Components and "props"
-
-### Deck Components
-
-- #### DeckContent
-
-  ##### Props
-
-  - mapping
-  - dataRecord
-  - query
-  - params
-  - pointer
-  - pointerArray
-  - defaultImage
-
-- #### DeckQueue
-  ##### Props
-  - page
-  - dataRecord
-  - query
-  - params
-  - pointer
-  - pointerArray
-
-### Layout Components
-
-- #### Column1
-- #### Column2
-  ##### Props
-  - rightItems
-- #### Column3
-  ##### Props
-  - leftItems
-  - rightItems
-  ##### Common Props (Column1, Column2, Column3)
-  - title
-  - children
-- #### Header
-  ##### Props
-  - title
-  - keyword
-  - description
-- #### LeftNav
-  ##### Props
-  - leftItems
-- #### AccordionPanel
-  ##### Props
-  - accordionClassName
-  - data
-
-### Navigation Components
-
-- #### NavMagazine
-  ##### Props
-  - logo
-  - dataObject
-- #### NavNative
-  ##### Props
-  - logo
-  - dataObject
-- #### NavNormal
-  ##### Props
-  - logo
-  - dataObject
-  - variant
-- #### NavDvm
-  ##### Props
-  - logo
-  - dataObject
-  - subNavHeads
-
-### Template Components
-
-- #### TemplateNormal
-  ##### Props
-  - config
-  - title
-  - keywords
-  - description
-  - website
-
-### Ad Components
-
-- #### AD300x250
-- #### AD300x250x600
-- #### AD728x90
-  ##### Common Props
-  - networkID
-  - adUnit
-
-### Serializers
-
-- #### getSerializers (function)
-  ##### arguments
-  - client
-  ##### types
-  - youtube
-  - figure
-  - slideshow
-
-## License
-
-MIT © [mjh-framework](https://github.com/mjh-framework)
+
+# mjh-framework v. 1.0.99
+
+
+> Foundation Framework
+
+[![NPM](https://img.shields.io/npm/v/mjh-framework.svg)](https://www.npmjs.com/package/mjh-framework) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+## Install
+
+```bash
+npm install --save @mjhls/mjh-framework
+```
+
+## Usage
+
+```jsx
+import React, { Component } from 'react'
+
+import { NavMagazine, DeckQueue } from 'mjh-framework'
+
+export default class App extends Component {
+  render() {
+    return (
+      <div>
+        <NavMagazine />
+        <DeckQueue />
+      </div>
+    )
+  }
+}
+```
+
+## Publish new updates to the npm registry
+
+```bash
+npm publish
+```
+
+## For getting updates in the template without publishing each time a change is made in the framework
+
+Link react and react-dom of the template repo, so that it can be used by the framework.
+This is to avoid the error arising due to multiple instances of React.
+
+```bash
+cd ../mjh-template/node_modules/react
+
+yarn link
+
+cd ../react-dom
+
+yarn link
+
+cd ../../../mjh-framework
+
+yarn link react && yarn link react-dom
+```
+
+Link the framework repo so that it can be used in the template
+
+```bash
+npm link
+
+cd ../mjh-template
+
+npm link @mjhls/mjh-framework
+```
+
+## Components and "props"
+
+### Deck Components
+
+- #### DeckContent
+
+  ##### Props
+
+  - mapping
+  - dataRecord
+  - query
+  - params
+  - pointer
+  - pointerArray
+  - defaultImage
+
+- #### DeckQueue
+  ##### Props
+  - page
+  - dataRecord
+  - query
+  - params
+  - pointer
+  - pointerArray
+
+### Layout Components
+
+- #### Column1
+- #### Column2
+  ##### Props
+  - rightItems
+- #### Column3
+  ##### Props
+  - leftItems
+  - rightItems
+  ##### Common Props (Column1, Column2, Column3)
+  - title
+  - children
+- #### Header
+  ##### Props
+  - title
+  - keyword
+  - description
+- #### LeftNav
+  ##### Props
+  - leftItems
+- #### AccordionPanel
+  ##### Props
+  - accordionClassName
+  - data
+
+### Navigation Components
+
+- #### NavMagazine
+  ##### Props
+  - logo
+  - dataObject
+- #### NavNative
+  ##### Props
+  - logo
+  - dataObject
+- #### NavNormal
+  ##### Props
+  - logo
+  - dataObject
+  - variant
+- #### NavDvm
+  ##### Props
+  - logo
+  - dataObject
+  - subNavHeads
+
+### Template Components
+
+- #### TemplateNormal
+  ##### Props
+  - config
+  - title
+  - keywords
+  - description
+  - website
+
+### Ad Components
+
+- #### AD300x250
+- #### AD300x250x600
+- #### AD728x90
+  ##### Common Props
+  - networkID
+  - adUnit
+
+### Serializers
+
+- #### getSerializers (function)
+  ##### arguments
+  - client
+  ##### types
+  - youtube
+  - figure
+  - slideshow
+
+## License
+
+MIT © [mjh-framework](https://github.com/mjh-framework)