@papillonarts/components 0.39.0 → 0.41.0

package/build/Legacy/Alert/Alert.type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Alert.type.d.ts","sourceRoot":"","sources":["../../../src/Legacy/Alert/Alert.type.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,YAAY,EAAE,aAQ1B,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,WAAW,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,YAAY,EAAE,aAU1B,CAAA;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,MAAM;IACrB,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,OAAO,CAAC,EAAE,aAAa,CAAA;CACxB"}
+{"version":3,"file":"Alert.type.d.ts","sourceRoot":"","sources":["../../../src/Legacy/Alert/Alert.type.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf;AAED,eAAO,MAAM,YAAY,EAAE,aAQ1B,CAAA;AAED,MAAM,WAAW,aAAa;IAC5B,UAAU,EAAE,WAAW,CAAA;IACvB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,YAAY,EAAE,aAU1B,CAAA;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;CAClC;AAED,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,mBAAmB,CAAA;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAGD,MAAM,WAAW,MAAM;IACrB,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IACzB,OAAO,CAAC,EAAE,aAAa,CAAA;CACxB"}

package/build/Legacy/Alert/Alert.type.js

@@ -23,4 +23,6 @@ var AlertDefault = exports.AlertDefault = {
   ClassName: null,
   Variant: AlertVariant.Default,
   Consent: null
-};
+};
+
+// https://react.dev/learn/typescript#typing-children

package/build/Legacy/Alert/__tests__/Alert.doc.md

@@ -1,111 +1,144 @@
-# Alert
+# Features
 
-> Alert component all features
+> Flash messages, or alerts, inform users of successful or pending actions. Use them sparingly. Don't show more than one at a time.
 
 ```
-# Featues
+Alert all props and variants
+```
+
+## Props
+
+```typescript
+export interface IAlert {
+  dataTestId?: IDataTestId
+  className?: string
+  variant?: string
+  children: React.ReactNode
+  consent?: IAlertConsent
+}
+```
+
+## Variants
+
+```
+Default
+
+DefaultMultipleParagraphs
+
+Info
+
+Warning
+
+Error
+
+Success
+
+Full
+
+Banner
+
+DefaultConsentWithInput
 
-> Default, DefaultMultipleParagraphs
-> Info, Warning, Error, Success
-> Full, Banner
-> DefaultConsentWithInput, DefaultConsentWithoutInput
+DefaultConsentWithoutInput
 ```
 
-## Default
+### Default
 
-> Alert component default feature
+> Alert default variant
+> Flash messages start off looking decently neutral—they're just light blue rounded rectangles.
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Default}>{children}</Alert>
 ```
 
-## DefaultMultipleParagraphs
+### Default Multiple Paragraphs
 
-> Alert component default multiple paragraphs feature
+> Alert default multiple paragraphs variant
+> You can put multiple paragraphs of text in a flash message—the last paragraph's bottom margin will be automatically override.
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Default}>
   <p>
-    This is a longer flash message in it's own paragraph. It ends up looking something like this. If we keep adding more text, it will
+    This is a longer flash message in it's own paragraph. It ends up looking something like this. If we keep adding more text, it'll
     eventually wrap to a new line.
   </p>
   <p>And this is another paragraph.</p>
 </Alert>
 ```
 
-## Info
+### Info
 
-> Alert component info feature
+> Alert info variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Info}>{children}</Alert>
 ```
 
-## Warning
+### Warning
 
-> Alert component warning feature
+> Alert warning variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Warning}>{children}</Alert>
 ```
 
-## Error
+### Error
 
-> Alert component error feature
+> Alert error variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Error}>{children}</Alert>
 ```
 
-## Success
+### Success
 
-> Alert component success feature
+> Alert success variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Success}>{children}</Alert>
 ```
 
-## Full
+### Full
 
-> Alert component full feature
+> Alert full variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Full}>{children}</Alert>
 ```
 
-## Banner
+### Banner
 
-> Alert component banner feature
+> Alert banner variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Banner}>{children}</Alert>
 ```
 
-## DefaultConsentWithInput
+### Default Consent With Input
 
-> Alert component default consent with input feature
+> Alert default consent with input variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Default} consent={getConsent({ hasInput: true })}>
   {children}
 </Alert>
 ```
 
-## DefaultConsentWithoutInput
+### Default Consent Without Input
 
-> Alert component default consent without input feature
+> Alert default consent without input variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Default} consent={getConsent({ hasInput: false })}>
   {children}
 </Alert>
 ```
 
-## DefaultConsentCustom
+### DefaultConsentCustom
 
-> Alert component default consent custom feature
+> Alert default consent custom variant
 
-```jsx
+```tsx
 <Alert variant={AlertVariant.Default} consent={consent}>
   {children}
 </Alert>

package/build/Legacy/Blankslate/__tests__/Blankslate.doc.md

@@ -1,57 +1,95 @@
-# Blankslate
+# Features
 
-> Blankslate component all features
+> Blankslates are for when there is a lack of content within a page or section. Use them as placeholders to tell users why something isn't there. Be sure to provide an action to add content as well.
 
 ```
-# Featues
+Blankslate all props and variants
+```
+
+## Props
+
+```typescript
+export interface IBlankslate {
+  className?: string
+  heading: string
+  text: string
+  variant?: string
+  hasCleanBackground?: boolean
+}
+```
+
+## Variants
 
-> Default, Narrow, Capped, Spacious, Large, CleanBackground
 ```
+Default
 
-## Default
+Narrow
 
-> Blankslate component default feature
+Capped
+
+Spacious
+
+Large
+
+CleanBackground
+```
 
-```jsx
+### Default
+
+> Blankslate default feature
+
+> Wrap some content in the outer .blankslate wrapper to give it the blankslate appearance.
+
+```tsx
 <Blankslate variant={BlankslateVariant.Default} heading={heading} text={text} />
 ```
 
-## Narrow
+### Narrow
+
+> Blankslate narrow feature
 
-> Blankslate component narrow feature
+> Narrows the blankslate container to not occupy the entire available width.
 
-```jsx
+```tsx
 <Blankslate variant={BlankslateVariant.Narrow} heading={heading} text={text} />
 ```
 
-## Capped
+### Capped
 
-> Blankslate component capped feature
+> Blankslate capped feature
 
-```jsx
+> Removes the border-radius on the top corners.
+
+```tsx
 <Blankslate variant={BlankslateVariant.Capped} heading={heading} text={text} />
 ```
 
-## Spacious
+### Spacious
+
+> Blankslate spacious feature
 
-> Blankslate component spacious feature
+> Significantly increases the vertical padding.
 
-```jsx
+```tsx
 <Blankslate variant={BlankslateVariant.Spacious} heading={heading} text={text} />
 ```
 
-## Large
+### Large
 
-> Blankslate component large feature
+> Blankslate large feature
 
-```jsx
+> Increases the size of the text in the blankslate
+
+```tsx
 <Blankslate variant={BlankslateVariant.Large} heading={heading} text={text} />
 ```
 
-## CleanBackground
+### Clean Background
+
+> Blankslate cleanBackground feature
 
-> Blankslate component cleanBackground feature
+> Removes the background-color and border.
 
-```jsx
+```tsx
 <Blankslate hasCleanBackground={true} heading={heading} text={text} />
 ```

package/build/Legacy/Breadcrumb/__tests__/Breadcrumb.doc.md

@@ -1,33 +1,59 @@
-# Breadcrumb
+# Features
 
-> Breadcrumb component all features
+> Breadcrumbs are used to show taxonomical context on pages that are many levels deep in a site’s hierarchy. Breadcrumbs show and link to parent, grandparent, and sometimes great-grandparent pages. Breadcrumbs are most appropriate on pages that:
+
+> Are many levels deep on a site
+
+> Do not have a section>level navigation
+
+> May need the ability to quickly go back to the previous (parent) page
 
 ```
-# Featues
+Breadcrumb all props and variants
+```
+
+## Props
+
+```typescript
+export interface IBreadcrumb {
+  className?: string
+  ariaAttr: IAriaAttr
+  items: IItem[]
+  onClick: (value) => void
+  state?: string
+}
+```
+
+## Variants
+
+```
+Default
+
+Active
 
-> Default, Active, Inactive
+Inactive
 ```
 
-## Default
+### Default
 
-> Breadcrumb component default feature
+> Breadcrumb default variant
 
-```jsx
+```tsx
 <Breadcrumb ariaAttr={ariaAttr} items={items} onClick={action('onClick')} />
 ```
 
-## Active
+### Active
 
-> Breadcrumb component active feature
+> Breadcrumb active variant
 
-```jsx
+```tsx
 <Breadcrumb ariaAttr={ariaAttr} items={items} onClick={action('onClick')} state={BreadcrumbState.Active} />
 ```
 
-## Inactive
+### Inactive
 
-> Breadcrumb component inactive feature
+> Breadcrumb inactive variant
 
-```jsx
+```tsx
 <Breadcrumb ariaAttr={ariaAttr} items={items} onClick={action('onClick')} state={BreadcrumbState.Inactive} />
 ```