@justeattakeaway/pie-card 0.14.3 → 0.15.0

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/README.md +5 -64
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -8,15 +8,6 @@
8
8
  </a>
9
9
  </p>
10
10
 
11
- # Table of Contents
12
-
13
- 1. [Introduction](#pie-card)
14
- 2. [Installation](#installation)
15
- 3. [Importing the component](#importing-the-component)
16
- 4. [Peer Dependencies](#peer-dependencies)
17
- 5. [Props](#props)
18
- 6. [Contributing](#contributing)
19
-
20
11
  ## pie-card
21
12
 
22
13
  `pie-card` is a Web Component built using the Lit library.
@@ -36,64 +27,14 @@ $ npm i @justeattakeaway/pie-card
36
27
  $ yarn add @justeattakeaway/pie-card
37
28
  ```
38
29
 
39
- For full information on using PIE components as part of an application, check out the [Getting Started Guide](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components).
40
-
41
-
42
- ### Importing the component
43
-
44
- #### JavaScript
45
- ```js
46
- // Default – for Native JS Applications, Vue, Angular, Svelte, etc.
47
- import { PieCard } from '@justeattakeaway/pie-card';
48
-
49
- // If you don't need to reference the imported object, you can simply
50
- // import the module which registers the component as a custom element.
51
- import '@justeattakeaway/pie-card';
52
- ```
53
-
54
- #### React
55
- ```js
56
- // React
57
- // For React, you will need to import our React-specific component build
58
- // which wraps the web component using ​@lit/react
59
- import { PieCard } from '@justeattakeaway/pie-card/dist/react';
60
- ```
30
+ ## Documentation
61
31
 
62
- > [!NOTE]
63
- > When using the React version of the component, please make sure to also
64
- > include React as a [peer dependency](#peer-dependencies) in your project.
32
+ Visit [Card | PIE Design System](https://pie.design/components/card/overview) to view more information on this component.
65
33
 
34
+ ## Questions
66
35
 
67
- ## Peer Dependencies
68
-
69
- > [!IMPORTANT]
70
- > When using `pie-card`, you will also need to include a couple of dependencies to ensure the component renders as expected. See [the PIE Wiki](https://github.com/justeattakeaway/pie/wiki/Getting-started-with-PIE-Web-Components#expected-dependencies) for more information and how to include these in your application.
71
-
72
- ## Props
73
-
74
- | Property | Type | Default | Description |
75
- |---|---|-------------|------------------------------------------------------------------------------------------------------------------------------|
76
- | tag | `String` | `button` | What HTML element the card should be such as a or button
77
- | variant | `string` | `default` | What style variant the card should be such as default, outline, inverse or outline-inverse |
78
- | disabled | `boolean` | `false` | When true, the card is disabled. |
79
- | href | `string` | `undefined` | The URL that the card should point to (this will not take effect unless the card is a link). |
80
- | target | `string` | `undefined` | Where to display the linked URL such as _self, _blank, _parent or _top (this will not take effect unless the card is a link). |
81
- | rel | `string` | `undefined` | What the relationship of the linked URL is (this will not take effect unless the card is a link). |
82
- | aria | `object` | `undefined` | The ARIA labels used for various parts of the card. |
83
- | isDraggable | `boolean` | `false` | Sets a grab/grabbing cursor when set to true. **Note:** the actual dragging capabilities should be implemented by the consuming application. |
84
- | padding | `String` | `undefined` | Sets the padding of the card. Can be either a single value or two values separated by commas. Setting a single value adds padding to all sides of the card, whereas setting two values will set the "topBottom, leftRight" padding. e.g `'a'` or `'a, b'` |
85
-
86
-
87
- In your markup or JSX, you can then use these to set the properties for the `pie-card` component:
88
-
89
- ```html
90
- <!-- Native HTML -->
91
- <pie-card disabled href="/foo/bar" rel="noopener" target="_blank"></pie-card>
92
-
93
- <!-- JSX -->
94
- <PieCard disabled href="/foo/bar" rel="noopener" target="_blank"></PieCard>
95
- ```
36
+ Please head to [FAQs | PIE Design System](https://pie.design/support/contact-us/) to see our FAQs and get in touch.
96
37
 
97
38
  ## Contributing
98
39
 
99
- Check out our [contributing guide](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide) for more information on [local development](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#local-development) and how to run specific [component tests](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#testing).
40
+ Check out our [contributing guide](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide) for more information on [local development](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#local-development) and how to run specific [component tests](https://github.com/justeattakeaway/pie/wiki/Contributing-Guide#testing).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@justeattakeaway/pie-card",
3
- "version": "0.14.3",
3
+ "version": "0.15.0",
4
4
  "description": "PIE Design System Card built using Web Components",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -28,7 +28,7 @@
28
28
  "author": "Just Eat Takeaway.com - Design System Team",
29
29
  "license": "Apache-2.0",
30
30
  "devDependencies": {
31
- "@justeattakeaway/pie-components-config": "0.6.1"
31
+ "@justeattakeaway/pie-components-config": "0.7.0"
32
32
  },
33
33
  "dependencies": {
34
34
  "@justeattakeaway/pie-webc-core": "0.13.0"