@pnx-mixtape/ids-shape 0.0.2 → 0.0.3

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 (2) hide show
  1. package/index.ts +72 -49
  2. package/package.json +2 -2
package/index.ts CHANGED
@@ -24,7 +24,7 @@ import {
24
24
  * Base.
25
25
  */
26
26
 
27
- type Icon = {
27
+ export type Icon = {
28
28
  icon: string
29
29
  text?: string
30
30
  align?: AlignmentTypes
@@ -34,7 +34,7 @@ type Icon = {
34
34
  customClasses?: string[]
35
35
  }
36
36
 
37
- type Link = {
37
+ export type Link = {
38
38
  title: string
39
39
  href: string
40
40
  more?: boolean
@@ -45,7 +45,7 @@ type Link = {
45
45
  customClasses?: string[]
46
46
  }
47
47
 
48
- type Button = {
48
+ export type Button = {
49
49
  title: string
50
50
  as: ButtonTypes
51
51
  modifiers?: ButtonModifiers[]
@@ -55,7 +55,7 @@ type Button = {
55
55
  customClasses?: string[]
56
56
  }
57
57
 
58
- type Heading = {
58
+ export type Heading = {
59
59
  title: string
60
60
  as: HeadingTypes
61
61
  modifiers?: HeadingTypes[]
@@ -65,30 +65,30 @@ type Heading = {
65
65
  customClasses?: string[]
66
66
  }
67
67
 
68
- type DefinitionListItem = {
68
+ export type DefinitionListItem = {
69
69
  title: string
70
70
  content: string | WysiwygText
71
71
  }
72
72
 
73
- type DefinitionList = {
73
+ export type DefinitionList = {
74
74
  items: DefinitionListItem[]
75
75
  title?: Heading
76
76
  customClasses?: string[]
77
77
  }
78
78
 
79
- type Video = {
79
+ export type Video = {
80
80
  src: string
81
81
  title: string
82
82
  duration?: string
83
83
  }
84
84
 
85
- type ImageSource = {
85
+ export type ImageSource = {
86
86
  srcset: string
87
87
  media: string
88
88
  type: string
89
89
  }
90
90
 
91
- type Image = {
91
+ export type Image = {
92
92
  src: string
93
93
  alt: string
94
94
  height?: string
@@ -97,7 +97,7 @@ type Image = {
97
97
  loading?: LoadingTypes
98
98
  }
99
99
 
100
- type Media = {
100
+ export type Media = {
101
101
  item: Image | Video
102
102
  caption?: string
103
103
  attribution?: string
@@ -105,7 +105,7 @@ type Media = {
105
105
  customClasses?: string[]
106
106
  }
107
107
 
108
- type FormControl = {
108
+ export type FormControl = {
109
109
  id: string
110
110
  name: string
111
111
  label: string
@@ -113,13 +113,13 @@ type FormControl = {
113
113
  checked?: boolean
114
114
  }
115
115
 
116
- type WysiwygText = HTMLElement[] // just an example.
116
+ export type WysiwygText = HTMLElement[] // just an example.
117
117
 
118
118
  /**
119
119
  * Extendable.
120
120
  */
121
121
 
122
- type WayfindingBlock = {
122
+ export type WayfindingBlock = {
123
123
  title?: Heading
124
124
  content?: string | WysiwygText
125
125
  link?: Link | Button
@@ -130,7 +130,7 @@ type WayfindingBlock = {
130
130
  * Layout.
131
131
  */
132
132
 
133
- type GridItem = {
133
+ export type GridItem = {
134
134
  item: HTMLElement
135
135
  container?: boolean
136
136
  modifiers?: GridItemModifiers[]
@@ -138,14 +138,14 @@ type GridItem = {
138
138
  customClasses?: string[]
139
139
  }
140
140
 
141
- type Grid = {
141
+ export type Grid = {
142
142
  items: GridItem[]
143
143
  modifiers?: GridModifiers[]
144
144
  as?: SectionTypes
145
145
  customClasses?: string[]
146
146
  }
147
147
 
148
- type Section = WayfindingBlock & {
148
+ export type Section = WayfindingBlock & {
149
149
  background?: string
150
150
  container?: boolean
151
151
  as?: SectionTypes
@@ -156,41 +156,41 @@ type Section = WayfindingBlock & {
156
156
  * Navigation.
157
157
  */
158
158
 
159
- type Breadcrumbs = {
159
+ export type Breadcrumbs = {
160
160
  items: Link[] | string
161
161
  modifier?: string
162
162
  }
163
163
 
164
- type InPageNavigation = {
164
+ export type InPageNavigation = {
165
165
  title?: Heading
166
166
  levels?: HeadingTypes[]
167
167
  }
168
168
 
169
- type PaginationItem = {
169
+ export type PaginationItem = {
170
170
  link?: Link
171
171
  ellipsis?: boolean
172
172
  }
173
173
 
174
- type Pagination = {
174
+ export type Pagination = {
175
175
  previous?: Link
176
176
  next?: Link
177
177
  pages?: PaginationItem[]
178
178
  customClasses?: string[]
179
179
  }
180
180
 
181
- type MenuTree = {
181
+ export type MenuTree = {
182
182
  link: Link
183
183
  items: MenuTree[]
184
184
  }
185
185
 
186
- type Navigation = {
186
+ export type Navigation = {
187
187
  id: string
188
188
  items: MenuTree[]
189
189
  title?: string
190
190
  customClasses?: string[]
191
191
  }
192
192
 
193
- type SideNavigation = Navigation & {
193
+ export type SideNavigation = Navigation & {
194
194
  parent: Link
195
195
  customClasses?: string[]
196
196
  }
@@ -199,32 +199,32 @@ type SideNavigation = Navigation & {
199
199
  * Components.
200
200
  */
201
201
 
202
- type LinkList = {
202
+ export type LinkList = {
203
203
  items: Link[]
204
204
  customClasses?: string[]
205
205
  }
206
206
 
207
- type AccordionItem = {
207
+ export type AccordionItem = {
208
208
  title: string
209
209
  content: string | WysiwygText
210
210
  open?: boolean
211
211
  id?: string
212
212
  }
213
213
 
214
- type Accordion = {
214
+ export type Accordion = {
215
215
  items: AccordionItem[]
216
216
  title?: Heading
217
217
  toggleAll?: boolean
218
218
  customClasses?: string[]
219
219
  }
220
220
 
221
- type Callout = {
221
+ export type Callout = {
222
222
  title: Heading
223
223
  content: string
224
224
  customClasses?: string[]
225
225
  }
226
226
 
227
- type Card = WayfindingBlock & {
227
+ export type Card = WayfindingBlock & {
228
228
  image?: Image
229
229
  icon?: Icon
230
230
  tags?: string[]
@@ -233,27 +233,27 @@ type Card = WayfindingBlock & {
233
233
  modifier?: CardModifier
234
234
  }
235
235
 
236
- type CardGrid = WayfindingBlock & {
236
+ export type CardGrid = WayfindingBlock & {
237
237
  items: Card[]
238
238
  container?: boolean
239
239
  modifiers?: GridModifiers[]
240
240
  as?: SectionTypes
241
241
  }
242
242
 
243
- type CardCarousel = WayfindingBlock & {
243
+ export type CardCarousel = WayfindingBlock & {
244
244
  items: Card[]
245
245
  loop: boolean
246
246
  pagination: boolean
247
247
  counter: boolean
248
248
  }
249
249
 
250
- type ContentBlock = WayfindingBlock & {
250
+ export type ContentBlock = WayfindingBlock & {
251
251
  image?: Image
252
252
  icon?: Icon
253
253
  linkList?: LinkList
254
254
  }
255
255
 
256
- type ContactDetails = {
256
+ export type ContactDetails = {
257
257
  title?: Heading
258
258
  name?: string
259
259
  phone?: string
@@ -263,13 +263,13 @@ type ContactDetails = {
263
263
  customClasses?: string[]
264
264
  }
265
265
 
266
- type Dialog = WayfindingBlock & {
266
+ export type Dialog = WayfindingBlock & {
267
267
  open: boolean
268
268
  id: string
269
269
  modal: boolean
270
270
  }
271
271
 
272
- type GlobalAlert = {
272
+ export type GlobalAlert = {
273
273
  id: string
274
274
  type: GlobalAlertTypes
275
275
  dismissible: boolean
@@ -279,7 +279,7 @@ type GlobalAlert = {
279
279
  customClasses?: string[]
280
280
  }
281
281
 
282
- type HeroBanner = WayfindingBlock & {
282
+ export type HeroBanner = WayfindingBlock & {
283
283
  subtitle?: string
284
284
  image?: Image
285
285
  linkList?: LinkList
@@ -287,7 +287,7 @@ type HeroBanner = WayfindingBlock & {
287
287
  modifier: HeroBannerModifier
288
288
  }
289
289
 
290
- type InPageAlert = {
290
+ export type InPageAlert = {
291
291
  type: InPageAlertTypes
292
292
  title: Heading
293
293
  content: string | WysiwygText
@@ -295,7 +295,7 @@ type InPageAlert = {
295
295
  customClasses?: string[]
296
296
  }
297
297
 
298
- type ListItem = WayfindingBlock & {
298
+ export type ListItem = WayfindingBlock & {
299
299
  tags?: string[]
300
300
  label?: string
301
301
  info?: string
@@ -303,11 +303,11 @@ type ListItem = WayfindingBlock & {
303
303
  image?: Image
304
304
  }
305
305
 
306
- type Popover = WayfindingBlock & {
306
+ export type Popover = WayfindingBlock & {
307
307
  id: string
308
308
  }
309
309
 
310
- type ResultsBar = {
310
+ export type ResultsBar = {
311
311
  number?: number
312
312
  pageCount?: number
313
313
  total?: number
@@ -316,12 +316,12 @@ type ResultsBar = {
316
316
  customClasses?: string[]
317
317
  }
318
318
 
319
- type StepItem = {
319
+ export type StepItem = {
320
320
  content: WysiwygText[]
321
321
  status: boolean
322
322
  }
323
323
 
324
- type Steps = {
324
+ export type Steps = {
325
325
  items: StepItem[],
326
326
  modifier?: StepsModifier
327
327
  fill?: boolean
@@ -330,12 +330,12 @@ type Steps = {
330
330
  customClasses?: string[]
331
331
  }
332
332
 
333
- type Logo = {
333
+ export type Logo = {
334
334
  link: Link
335
335
  image: Image
336
336
  }
337
337
 
338
- type SupportList = {
338
+ export type SupportList = {
339
339
  logos: Logo[]
340
340
  title?: Heading
341
341
  links?: Link[]
@@ -343,32 +343,32 @@ type SupportList = {
343
343
  customClasses?: string[]
344
344
  }
345
345
 
346
- type TabItem = {
346
+ export type TabItem = {
347
347
  id: string
348
348
  title: string
349
349
  content: string | WysiwygText
350
350
  active?: boolean
351
351
  }
352
352
 
353
- type Tabs = {
353
+ export type Tabs = {
354
354
  items: TabItem[]
355
355
  modifier?: string
356
356
  customClasses?: string[]
357
357
  }
358
358
 
359
- type Tags = {
359
+ export type Tags = {
360
360
  items: Link[] | string[] | FormControl[]
361
361
  type: TagTypes
362
362
  customClasses?: string[]
363
363
  }
364
364
 
365
- type SocialLinks = {
365
+ export type SocialLinks = {
366
366
  title?: Heading
367
367
  items: Link[]
368
368
  customClasses?: string[]
369
369
  }
370
370
 
371
- type SocialShare = {
371
+ export type SocialShare = {
372
372
  facebook?: boolean
373
373
  linkedin?: boolean
374
374
  twitter?: boolean
@@ -376,10 +376,33 @@ type SocialShare = {
376
376
  customClasses?: string[]
377
377
  }
378
378
 
379
- type UtilityList = {
379
+ export type UtilityList = {
380
380
  copy?: boolean
381
381
  print?: boolean
382
382
  pdf?: boolean
383
383
  share?: SocialShare
384
384
  customClasses?: string[]
385
385
  }
386
+
387
+ export {
388
+ AlignmentTypes,
389
+ AsTypes,
390
+ ButtonModifiers,
391
+ ButtonTypes,
392
+ CardModifier,
393
+ GlobalAlertTypes,
394
+ GridItemModifiers,
395
+ GridModifiers,
396
+ HeadingTypes,
397
+ HeroBannerModifier,
398
+ IconColourModifier,
399
+ IconRotateModifier,
400
+ IconSizeModifier,
401
+ InPageAlertTypes,
402
+ LoadingTypes,
403
+ MediaAlignmentTypes,
404
+ SectionModifiers,
405
+ SectionTypes,
406
+ StepsModifier,
407
+ TagTypes,
408
+ }
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@pnx-mixtape/ids-shape",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "description": "shape details for ids project",
5
- "main": "shape/index.ts",
5
+ "main": "./index.ts",
6
6
  "type": "module",
7
7
  "devDependencies": {},
8
8
  "scripts": {