@contentful/f36-accordion 4.0.1 → 4.1.2

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 (9) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/README.mdx +9 -38
  3. package/dist/main.js +0 -0
  4. package/dist/main.js.map +0 -0
  5. package/dist/module.js +0 -0
  6. package/dist/module.js.map +0 -0
  7. package/dist/types.d.ts +2 -18
  8. package/dist/types.d.ts.map +1 -1
  9. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -3,6 +3,41 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [4.1.2](https://github.com/contentful/forma-36/compare/@contentful/f36-accordion@4.1.1...@contentful/f36-accordion@4.1.2) (2022-01-31)
7
+
8
+ **Note:** Version bump only for package @contentful/f36-accordion
9
+
10
+
11
+
12
+
13
+
14
+ ## [4.1.1](https://github.com/contentful/forma-36/compare/@contentful/f36-accordion@4.1.0...@contentful/f36-accordion@4.1.1) (2022-01-31)
15
+
16
+ **Note:** Version bump only for package @contentful/f36-accordion
17
+
18
+
19
+
20
+
21
+
22
+ # [4.1.0](https://github.com/contentful/forma-36/compare/@contentful/f36-accordion@4.0.2...@contentful/f36-accordion@4.1.0) (2022-01-24)
23
+
24
+
25
+ ### Features
26
+
27
+ * implement props list redesign [BAU-535] ([#1756](https://github.com/contentful/forma-36/issues/1756)) ([21c57e7](https://github.com/contentful/forma-36/commit/21c57e72008b75990d03af4e7500edc1c7f3d26d))
28
+
29
+
30
+
31
+
32
+
33
+ ## [4.0.2](https://github.com/contentful/forma-36/compare/@contentful/f36-accordion@4.0.1...@contentful/f36-accordion@4.0.2) (2022-01-12)
34
+
35
+ **Note:** Version bump only for package @contentful/f36-accordion
36
+
37
+
38
+
39
+
40
+
6
41
  ## [4.0.1](https://github.com/contentful/forma-36/compare/@contentful/f36-accordion@4.0.0...@contentful/f36-accordion@4.0.1) (2022-01-11)
7
42
 
8
43
  **Note:** Version bump only for package @contentful/f36-accordion
package/README.mdx CHANGED
@@ -1,15 +1,11 @@
1
1
  ---
2
2
  title: 'Accordion'
3
+ type: 'component'
3
4
  slug: /components/accordion/
4
5
  github: 'https://github.com/contentful/forma-36/tree/master/packages/components/accordion'
5
- storybook: 'https://v4-f36-storybook.netlify.app/?path=/story/components-accordion'
6
6
  typescript: ./src/Accordion.tsx,./src/AccordionItem/AccordionItem.tsx
7
7
  ---
8
8
 
9
- import { Heading, Stack, TextLink } from '@contentful/f36-components';
10
- import { ExternalLinkIcon } from '@contentful/f36-icons';
11
- import { Props } from '@contentful/f36-docs-utils';
12
-
13
9
  Accordions are a good way to deliver a large amount of information. An accordion is a list of headers that after being clicked reveal or hide more content related to them.
14
10
  The header gives the user a summary of the content and the user decides if they need to see the extended content or not.
15
11
 
@@ -17,6 +13,8 @@ The header gives the user a summary of the content and the user decides if they
17
13
 
18
14
  ```jsx static=true
19
15
  import { Accordion } from '@contentful/f36-components';
16
+ // or
17
+ import { Accordion } from '@contentful/f36-accordion';
20
18
  ```
21
19
 
22
20
  ## Examples
@@ -25,54 +23,27 @@ The accordion has two variations that define the alignment of the chevron icon:
25
23
 
26
24
  ### Basic usage
27
25
 
28
- ```jsx
29
- <Accordion>
30
- <Accordion.Item title="What payment methods do you accept?">
31
- <Text>
32
- Customers on the Team tier can pay with a credit card (American Express,
33
- MasterCard or Visa). Enterprise customers have the choice of paying with a
34
- credit card or wire transfer.
35
- </Text>
36
- </Accordion.Item>
37
- </Accordion>
26
+ ```jsx file=./examples/AccordionExample.tsx
27
+
38
28
  ```
39
29
 
40
30
  ### Using it with other components
41
31
 
42
32
  Other typographic components can be passed as the accordion's title and anything can be used as the accordion's content. For example:
43
33
 
44
- ```jsx
45
- <Accordion>
46
- <Accordion.Item
47
- title={
48
- <SectionHeading marginBottom="none">
49
- What payment methods do you accept?
50
- </SectionHeading>
51
- }
52
- >
53
- <Stack flexDirection="column">
54
- <Text marginBottom="spacingS">
55
- Customers on the Team tier can pay with a credit card (American Express,
56
- MasterCard or Visa). Enterprise customers have the choice of paying with
57
- a credit card or wire transfer.
58
- </Text>
59
- <Button onClick={() => console.log('clicked!')}>
60
- Accordion’s button
61
- </Button>
62
- </Stack>
63
- </Accordion.Item>
64
- </Accordion>
34
+ ```jsx file=./examples/AccordionWithOtherComponentExample.tsx
35
+
65
36
  ```
66
37
 
67
38
  ## Props (API reference)
68
39
 
69
40
  ### Accordion
70
41
 
71
- <Props of="Accordion" storybookPath="/story/components-accordion" />
42
+ <PropsTable of="Accordion" />
72
43
 
73
44
  ### Accordion.Item
74
45
 
75
- <Props of="AccordionItem" />
46
+ <PropsTable of="AccordionItem" />
76
47
 
77
48
  ## Content guidelines
78
49
 
package/dist/main.js CHANGED
File without changes
package/dist/main.js.map CHANGED
File without changes
package/dist/module.js CHANGED
File without changes
package/dist/module.js.map CHANGED
File without changes
package/dist/types.d.ts CHANGED
@@ -12,13 +12,7 @@ export interface AccordionProps extends CommonProps {
12
12
  */
13
13
  children?: React.ReactNode;
14
14
  }
15
- declare const _Accordion1: React.ForwardRefExoticComponent<{
16
- align?: 'start' | 'end';
17
- children?: React.ReactNode;
18
- className?: string;
19
- testId?: string;
20
- style?: React.CSSProperties;
21
- } & React.RefAttributes<HTMLUListElement>>;
15
+ declare const _Accordion1: React.ForwardRefExoticComponent<AccordionProps & React.RefAttributes<HTMLUListElement>>;
22
16
  export interface AccordionHeaderProps extends CommonProps {
23
17
  /**
24
18
  * Child nodes to be rendered in the component
@@ -87,17 +81,7 @@ export interface AccordionItemProps extends CommonProps {
87
81
  */
88
82
  align?: 'start' | 'end';
89
83
  }
90
- export const AccordionItem: React.ForwardRefExoticComponent<{
91
- title?: React.ReactNode;
92
- titleElement?: HeadingElement;
93
- children?: React.ReactNode;
94
- onExpand?: Function;
95
- onCollapse?: Function;
96
- align?: 'start' | 'end';
97
- className?: string;
98
- testId?: string;
99
- style?: React.CSSProperties;
100
- } & React.RefAttributes<HTMLLIElement>>;
84
+ export const AccordionItem: React.ForwardRefExoticComponent<AccordionItemProps & React.RefAttributes<HTMLLIElement>>;
101
85
  type CompoundAccordion = typeof _Accordion1 & {
102
86
  Item: typeof AccordionItem;
103
87
  };
package/dist/types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"mappings":";;;ACMA,+BAAgC,SAAQ,WAAW;IACjD;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;CAC5B;AAiCD,QAAO,MAAM;YAtCH,OAAO,GAAG,KAAK;eAIZ,MAAM,SAAS;;;;0CAkCyB,CAAC;AEzCtD,qCAAsC,SAAQ,WAAW;IACvD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;CACzB;AAED,OAAO,MAAM,8FASV,oBAAoB,gBAqBtB,CAAC;AE3DF,oCAAqC,SAAQ,WAAW;IACtD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,OAAO,MAAM,gBAAgB,GAAG,YAAY,mBAAmB,CAAC,CAmB/D,CAAC;AE9BF,mCAAoC,SAAQ,WAAW;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,SAAS,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;CACzB;AAwDD,OAAO,MAAM;YA7EH,MAAM,SAAS;mBAIR,cAAc;eAIlB,MAAM,SAAS;eAIf,QAAQ;iBAIN,QAAQ;YAIb,OAAO,GAAG,KAAK;;;;uCAyDoC,CAAC;ACxF9D,yBAAyB,kBAAwB,GAAG;IAClD,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC;AAEF,OAAO,MAAM,4BAAkD,CAAC","sources":["packages/components/accordion/src/src/Accordion.styles.ts","packages/components/accordion/src/src/Accordion.tsx","packages/components/accordion/src/src/AccordionHeader/AccordionHeader.styles.ts","packages/components/accordion/src/src/AccordionHeader/AccordionHeader.tsx","packages/components/accordion/src/src/AccordionPanel/AccordionPanel.styles.ts","packages/components/accordion/src/src/AccordionPanel/AccordionPanel.tsx","packages/components/accordion/src/src/AccordionItem/AccordionItem.styles.ts","packages/components/accordion/src/src/AccordionItem/AccordionItem.tsx","packages/components/accordion/src/src/CompoundAccordion.tsx","packages/components/accordion/src/src/index.ts","packages/components/accordion/src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,"export { Accordion } from './CompoundAccordion';\nexport type { AccordionProps } from './Accordion';\nexport { AccordionHeader } from './AccordionHeader/AccordionHeader';\nexport type { AccordionHeaderProps } from './AccordionHeader/AccordionHeader';\nexport { AccordionItem } from './AccordionItem/AccordionItem';\nexport type { AccordionItemProps } from './AccordionItem/AccordionItem';\nexport { AccordionPanel } from './AccordionPanel/AccordionPanel';\nexport type { AccordionPanelProps } from './AccordionPanel/AccordionPanel';\n"],"names":[],"version":3,"file":"types.d.ts.map"}
1
+ {"mappings":";;;ACMA,+BAAgC,SAAQ,WAAW;IACjD;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;CAC5B;AAiCD,QAAO,MAAM,oGAAwC,CAAC;AEzCtD,qCAAsC,SAAQ,WAAW;IACvD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;CACzB;AAED,OAAO,MAAM,8FASV,oBAAoB,gBAqBtB,CAAC;AE3DF,oCAAqC,SAAQ,WAAW;IACtD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,OAAO,MAAM,gBAAgB,GAAG,YAAY,mBAAmB,CAAC,CAmB/D,CAAC;AE9BF,mCAAoC,SAAQ,WAAW;IACrD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,SAAS,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,SAAS,CAAC;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;CACzB;AAwDD,OAAO,MAAM,uGAAgD,CAAC;ACxF9D,yBAAyB,kBAAwB,GAAG;IAClD,IAAI,EAAE,oBAAoB,CAAC;CAC5B,CAAC;AAEF,OAAO,MAAM,4BAAkD,CAAC","sources":["packages/components/accordion/src/src/Accordion.styles.ts","packages/components/accordion/src/src/Accordion.tsx","packages/components/accordion/src/src/AccordionHeader/AccordionHeader.styles.ts","packages/components/accordion/src/src/AccordionHeader/AccordionHeader.tsx","packages/components/accordion/src/src/AccordionPanel/AccordionPanel.styles.ts","packages/components/accordion/src/src/AccordionPanel/AccordionPanel.tsx","packages/components/accordion/src/src/AccordionItem/AccordionItem.styles.ts","packages/components/accordion/src/src/AccordionItem/AccordionItem.tsx","packages/components/accordion/src/src/CompoundAccordion.tsx","packages/components/accordion/src/src/index.ts","packages/components/accordion/src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,"export { Accordion } from './CompoundAccordion';\nexport type { AccordionProps } from './Accordion';\nexport { AccordionHeader } from './AccordionHeader/AccordionHeader';\nexport type { AccordionHeaderProps } from './AccordionHeader/AccordionHeader';\nexport { AccordionItem } from './AccordionItem/AccordionItem';\nexport type { AccordionItemProps } from './AccordionItem/AccordionItem';\nexport { AccordionPanel } from './AccordionPanel/AccordionPanel';\nexport type { AccordionPanelProps } from './AccordionPanel/AccordionPanel';\n"],"names":[],"version":3,"file":"types.d.ts.map"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentful/f36-accordion",
3
- "version": "4.0.1",
3
+ "version": "4.1.2",
4
4
  "description": "Forma 36: Accordion React Component",
5
5
  "license": "MIT",
6
6
  "files": [
@@ -21,11 +21,11 @@
21
21
  },
22
22
  "dependencies": {
23
23
  "@babel/runtime": "^7.6.2",
24
- "@contentful/f36-collapse": "^4.1.0",
25
- "@contentful/f36-core": "^4.0.1",
26
- "@contentful/f36-icons": "^4.0.1",
24
+ "@contentful/f36-collapse": "^4.2.2",
25
+ "@contentful/f36-core": "^4.1.1",
26
+ "@contentful/f36-icons": "^4.0.3",
27
27
  "@contentful/f36-tokens": "^4.0.0",
28
- "@contentful/f36-typography": "^4.0.1",
28
+ "@contentful/f36-typography": "^4.1.1",
29
29
  "emotion": "^10.0.17"
30
30
  },
31
31
  "peerDependencies": {
@@ -34,5 +34,5 @@
34
34
  "publishConfig": {
35
35
  "access": "public"
36
36
  },
37
- "gitHead": "cee6bd9ae0b1ca2ce23d42873d9344a20fe740d0"
37
+ "gitHead": "721631baa9a9904e6c4fa2224885604e23d3d21f"
38
38
  }