@cfpb/design-system-react 0.0.8 → 0.0.10

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.
@@ -17,7 +17,7 @@ interface AlertProperties {
17
17
  showIcon?: boolean;
18
18
  }
19
19
  /**
20
- * Alerts draw a user’s attention to a change in the status of a form or page. Form-level alerts reflect a user or system action and appear below the form title. Field-level alerts appear inline with input fields and can highlight successful submissions, errors that need to be corrected, or details to know before submitting a form. *
20
+ * Alerts draw a user’s attention to a change in the status of a form or page. Form-level alerts reflect a user or system action and appear below the form title. Field-level alerts appear inline with input fields and can highlight successful submissions, errors that need to be corrected, or details to know before submitting a form.
21
21
  *
22
22
  * Source: https://cfpb.github.io/design-system/components/alerts
23
23
  *
@@ -5,7 +5,7 @@ interface BannerProperties extends React.HTMLProps<HTMLDivElement> {
5
5
  tagline?: JSX.Element | string;
6
6
  }
7
7
  /**
8
- *The US gov banner identifies official websites of government organizations in the United States. It helps visitors understand whether a website is official and secure.
8
+ * The US gov banner identifies official websites of government organizations in the United States. It helps visitors understand whether a website is official and secure.
9
9
  *
10
10
  * Source: <a href='https://cfpb.github.io/design-system/components/banner-us-gov' target='_blank'> https://cfpb.github.io/design-system/components/banner-us-gov</a>
11
11
  */
@@ -0,0 +1,18 @@
1
+ import type React from 'react';
2
+ import type { ReactNode } from 'react';
3
+ export interface SummaryProperties extends React.HTMLAttributes<HTMLDivElement> {
4
+ children: ReactNode;
5
+ /** Label for the toggle button */
6
+ label?: string;
7
+ /** Whether the summary behavior should only apply on mobile viewports */
8
+ isMobileOnly?: boolean;
9
+ /** Use the minimal variation with toggle capabilities */
10
+ isMinimal?: boolean;
11
+ }
12
+ /**
13
+ * Summary components hides content over a certain height. When the hidden content is shown it can’t be reverted to the summary until the page is reloaded.
14
+ *
15
+ * Source: <a href='https://cfpb.github.io/design-system/components/summaries' target='_blank'>https://cfpb.github.io/design-system/components/summaries</a>
16
+ */
17
+ export declare const Summary: React.FC<SummaryProperties>;
18
+ export default Summary;
package/dist/index.d.ts CHANGED
@@ -32,6 +32,7 @@ export { default as ResponsiveMenu } from './components/ResponsiveMenu/Responsiv
32
32
  export { Select } from './components/Select/Select';
33
33
  export { SelectMulti } from './components/Select/SelectMulti';
34
34
  export { SelectSingle } from './components/Select/SelectSingle';
35
+ export { Summary } from './components/Summaries/Summary';
35
36
  export { default as SkipNav } from './components/SkipNav/SkipNav';
36
37
  export { Table } from './components/Table/Table';
37
38
  export { Tagline } from './components/Tagline/Tagline';