@mjhls/mjh-framework 1.0.145 → 1.0.147
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.
- package/README.md +173 -173
- package/dist/index.es.js +22140 -10651
- package/dist/index.es.js.map +1 -1
- package/dist/index.js +22140 -10650
- package/dist/index.js.map +1 -1
- package/package.json +90 -90
package/README.md
CHANGED
|
@@ -1,173 +1,173 @@
|
|
|
1
|
-
|
|
2
|
-
# mjh-framework v. 1.0.
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
> Foundation Framework
|
|
7
|
-
|
|
8
|
-
[](https://www.npmjs.com/package/mjh-framework) [](https://standardjs.com)
|
|
9
|
-
|
|
10
|
-
## Install
|
|
11
|
-
|
|
12
|
-
```bash
|
|
13
|
-
npm install --save @mjhls/mjh-framework
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Usage
|
|
17
|
-
|
|
18
|
-
```jsx
|
|
19
|
-
import React, { Component } from 'react'
|
|
20
|
-
|
|
21
|
-
import { NavMagazine, DeckQueue } from 'mjh-framework'
|
|
22
|
-
|
|
23
|
-
export default class App extends Component {
|
|
24
|
-
render() {
|
|
25
|
-
return (
|
|
26
|
-
<div>
|
|
27
|
-
<NavMagazine />
|
|
28
|
-
<DeckQueue />
|
|
29
|
-
</div>
|
|
30
|
-
)
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Publish new updates to the npm registry
|
|
36
|
-
|
|
37
|
-
```bash
|
|
38
|
-
npm publish
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## For getting updates in the template without publishing each time a change is made in the framework
|
|
42
|
-
|
|
43
|
-
Link react and react-dom of the template repo, so that it can be used by the framework.
|
|
44
|
-
This is to avoid the error arising due to multiple instances of React.
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
cd ../mjh-template/node_modules/react
|
|
48
|
-
|
|
49
|
-
yarn link
|
|
50
|
-
|
|
51
|
-
cd ../react-dom
|
|
52
|
-
|
|
53
|
-
yarn link
|
|
54
|
-
|
|
55
|
-
cd ../../../mjh-framework
|
|
56
|
-
|
|
57
|
-
yarn link react && yarn link react-dom
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
Link the framework repo so that it can be used in the template
|
|
61
|
-
|
|
62
|
-
```bash
|
|
63
|
-
npm link
|
|
64
|
-
|
|
65
|
-
cd ../mjh-template
|
|
66
|
-
|
|
67
|
-
npm link @mjhls/mjh-framework
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
## Components and "props"
|
|
71
|
-
|
|
72
|
-
### Deck Components
|
|
73
|
-
|
|
74
|
-
- #### DeckContent
|
|
75
|
-
|
|
76
|
-
##### Props
|
|
77
|
-
|
|
78
|
-
- mapping
|
|
79
|
-
- dataRecord
|
|
80
|
-
- query
|
|
81
|
-
- params
|
|
82
|
-
- pointer
|
|
83
|
-
- pointerArray
|
|
84
|
-
- defaultImage
|
|
85
|
-
|
|
86
|
-
- #### DeckQueue
|
|
87
|
-
##### Props
|
|
88
|
-
- page
|
|
89
|
-
- dataRecord
|
|
90
|
-
- query
|
|
91
|
-
- params
|
|
92
|
-
- pointer
|
|
93
|
-
- pointerArray
|
|
94
|
-
|
|
95
|
-
### Layout Components
|
|
96
|
-
|
|
97
|
-
- #### Column1
|
|
98
|
-
- #### Column2
|
|
99
|
-
##### Props
|
|
100
|
-
- rightItems
|
|
101
|
-
- #### Column3
|
|
102
|
-
##### Props
|
|
103
|
-
- leftItems
|
|
104
|
-
- rightItems
|
|
105
|
-
##### Common Props (Column1, Column2, Column3)
|
|
106
|
-
- title
|
|
107
|
-
- children
|
|
108
|
-
- #### Header
|
|
109
|
-
##### Props
|
|
110
|
-
- title
|
|
111
|
-
- keyword
|
|
112
|
-
- description
|
|
113
|
-
- #### LeftNav
|
|
114
|
-
##### Props
|
|
115
|
-
- leftItems
|
|
116
|
-
- #### AccordionPanel
|
|
117
|
-
##### Props
|
|
118
|
-
- accordionClassName
|
|
119
|
-
- data
|
|
120
|
-
|
|
121
|
-
### Navigation Components
|
|
122
|
-
|
|
123
|
-
- #### NavMagazine
|
|
124
|
-
##### Props
|
|
125
|
-
- logo
|
|
126
|
-
- dataObject
|
|
127
|
-
- #### NavNative
|
|
128
|
-
##### Props
|
|
129
|
-
- logo
|
|
130
|
-
- dataObject
|
|
131
|
-
- #### NavNormal
|
|
132
|
-
##### Props
|
|
133
|
-
- logo
|
|
134
|
-
- dataObject
|
|
135
|
-
- variant
|
|
136
|
-
- #### NavDvm
|
|
137
|
-
##### Props
|
|
138
|
-
- logo
|
|
139
|
-
- dataObject
|
|
140
|
-
- subNavHeads
|
|
141
|
-
|
|
142
|
-
### Template Components
|
|
143
|
-
|
|
144
|
-
- #### TemplateNormal
|
|
145
|
-
##### Props
|
|
146
|
-
- config
|
|
147
|
-
- title
|
|
148
|
-
- keywords
|
|
149
|
-
- description
|
|
150
|
-
- website
|
|
151
|
-
|
|
152
|
-
### Ad Components
|
|
153
|
-
|
|
154
|
-
- #### AD300x250
|
|
155
|
-
- #### AD300x250x600
|
|
156
|
-
- #### AD728x90
|
|
157
|
-
##### Common Props
|
|
158
|
-
- networkID
|
|
159
|
-
- adUnit
|
|
160
|
-
|
|
161
|
-
### Serializers
|
|
162
|
-
|
|
163
|
-
- #### getSerializers (function)
|
|
164
|
-
##### arguments
|
|
165
|
-
- client
|
|
166
|
-
##### types
|
|
167
|
-
- youtube
|
|
168
|
-
- figure
|
|
169
|
-
- slideshow
|
|
170
|
-
|
|
171
|
-
## License
|
|
172
|
-
|
|
173
|
-
MIT © [mjh-framework](https://github.com/mjh-framework)
|
|
1
|
+
|
|
2
|
+
# mjh-framework v. 1.0.147
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
> Foundation Framework
|
|
7
|
+
|
|
8
|
+
[](https://www.npmjs.com/package/mjh-framework) [](https://standardjs.com)
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install --save @mjhls/mjh-framework
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```jsx
|
|
19
|
+
import React, { Component } from 'react'
|
|
20
|
+
|
|
21
|
+
import { NavMagazine, DeckQueue } from 'mjh-framework'
|
|
22
|
+
|
|
23
|
+
export default class App extends Component {
|
|
24
|
+
render() {
|
|
25
|
+
return (
|
|
26
|
+
<div>
|
|
27
|
+
<NavMagazine />
|
|
28
|
+
<DeckQueue />
|
|
29
|
+
</div>
|
|
30
|
+
)
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Publish new updates to the npm registry
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm publish
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## For getting updates in the template without publishing each time a change is made in the framework
|
|
42
|
+
|
|
43
|
+
Link react and react-dom of the template repo, so that it can be used by the framework.
|
|
44
|
+
This is to avoid the error arising due to multiple instances of React.
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
cd ../mjh-template/node_modules/react
|
|
48
|
+
|
|
49
|
+
yarn link
|
|
50
|
+
|
|
51
|
+
cd ../react-dom
|
|
52
|
+
|
|
53
|
+
yarn link
|
|
54
|
+
|
|
55
|
+
cd ../../../mjh-framework
|
|
56
|
+
|
|
57
|
+
yarn link react && yarn link react-dom
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Link the framework repo so that it can be used in the template
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
npm link
|
|
64
|
+
|
|
65
|
+
cd ../mjh-template
|
|
66
|
+
|
|
67
|
+
npm link @mjhls/mjh-framework
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Components and "props"
|
|
71
|
+
|
|
72
|
+
### Deck Components
|
|
73
|
+
|
|
74
|
+
- #### DeckContent
|
|
75
|
+
|
|
76
|
+
##### Props
|
|
77
|
+
|
|
78
|
+
- mapping
|
|
79
|
+
- dataRecord
|
|
80
|
+
- query
|
|
81
|
+
- params
|
|
82
|
+
- pointer
|
|
83
|
+
- pointerArray
|
|
84
|
+
- defaultImage
|
|
85
|
+
|
|
86
|
+
- #### DeckQueue
|
|
87
|
+
##### Props
|
|
88
|
+
- page
|
|
89
|
+
- dataRecord
|
|
90
|
+
- query
|
|
91
|
+
- params
|
|
92
|
+
- pointer
|
|
93
|
+
- pointerArray
|
|
94
|
+
|
|
95
|
+
### Layout Components
|
|
96
|
+
|
|
97
|
+
- #### Column1
|
|
98
|
+
- #### Column2
|
|
99
|
+
##### Props
|
|
100
|
+
- rightItems
|
|
101
|
+
- #### Column3
|
|
102
|
+
##### Props
|
|
103
|
+
- leftItems
|
|
104
|
+
- rightItems
|
|
105
|
+
##### Common Props (Column1, Column2, Column3)
|
|
106
|
+
- title
|
|
107
|
+
- children
|
|
108
|
+
- #### Header
|
|
109
|
+
##### Props
|
|
110
|
+
- title
|
|
111
|
+
- keyword
|
|
112
|
+
- description
|
|
113
|
+
- #### LeftNav
|
|
114
|
+
##### Props
|
|
115
|
+
- leftItems
|
|
116
|
+
- #### AccordionPanel
|
|
117
|
+
##### Props
|
|
118
|
+
- accordionClassName
|
|
119
|
+
- data
|
|
120
|
+
|
|
121
|
+
### Navigation Components
|
|
122
|
+
|
|
123
|
+
- #### NavMagazine
|
|
124
|
+
##### Props
|
|
125
|
+
- logo
|
|
126
|
+
- dataObject
|
|
127
|
+
- #### NavNative
|
|
128
|
+
##### Props
|
|
129
|
+
- logo
|
|
130
|
+
- dataObject
|
|
131
|
+
- #### NavNormal
|
|
132
|
+
##### Props
|
|
133
|
+
- logo
|
|
134
|
+
- dataObject
|
|
135
|
+
- variant
|
|
136
|
+
- #### NavDvm
|
|
137
|
+
##### Props
|
|
138
|
+
- logo
|
|
139
|
+
- dataObject
|
|
140
|
+
- subNavHeads
|
|
141
|
+
|
|
142
|
+
### Template Components
|
|
143
|
+
|
|
144
|
+
- #### TemplateNormal
|
|
145
|
+
##### Props
|
|
146
|
+
- config
|
|
147
|
+
- title
|
|
148
|
+
- keywords
|
|
149
|
+
- description
|
|
150
|
+
- website
|
|
151
|
+
|
|
152
|
+
### Ad Components
|
|
153
|
+
|
|
154
|
+
- #### AD300x250
|
|
155
|
+
- #### AD300x250x600
|
|
156
|
+
- #### AD728x90
|
|
157
|
+
##### Common Props
|
|
158
|
+
- networkID
|
|
159
|
+
- adUnit
|
|
160
|
+
|
|
161
|
+
### Serializers
|
|
162
|
+
|
|
163
|
+
- #### getSerializers (function)
|
|
164
|
+
##### arguments
|
|
165
|
+
- client
|
|
166
|
+
##### types
|
|
167
|
+
- youtube
|
|
168
|
+
- figure
|
|
169
|
+
- slideshow
|
|
170
|
+
|
|
171
|
+
## License
|
|
172
|
+
|
|
173
|
+
MIT © [mjh-framework](https://github.com/mjh-framework)
|