@justeattakeaway/pie-textarea 0.6.0 → 0.6.1
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.
- package/README.md +6 -65
- package/package.json +4 -3
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-textarea)
|
|
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-textarea
|
|
21
12
|
|
|
22
13
|
`pie-textarea` is a Web Component built using the Lit library.
|
|
@@ -29,70 +20,20 @@ This component can be easily integrated into various frontend frameworks and cus
|
|
|
29
20
|
To install `pie-textarea` in your application, run the following on your command line:
|
|
30
21
|
|
|
31
22
|
```bash
|
|
32
|
-
|
|
33
|
-
$ npm i @justeattakeaway/pie-textarea
|
|
23
|
+
npm i @justeattakeaway/pie-textarea
|
|
34
24
|
|
|
35
|
-
|
|
36
|
-
$ yarn add @justeattakeaway/pie-textarea
|
|
25
|
+
yarn add @justeattakeaway/pie-textarea
|
|
37
26
|
```
|
|
38
27
|
|
|
39
28
|
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
29
|
|
|
30
|
+
## Documentation
|
|
41
31
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
#### JavaScript
|
|
45
|
-
```js
|
|
46
|
-
// Default – for Native JS Applications, Vue, Angular, Svelte, etc.
|
|
47
|
-
import { PieTextarea } from '@justeattakeaway/pie-textarea';
|
|
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-textarea';
|
|
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 { PieTextarea } from '@justeattakeaway/pie-textarea/dist/react';
|
|
60
|
-
```
|
|
61
|
-
|
|
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.
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
## Peer Dependencies
|
|
68
|
-
|
|
69
|
-
> [!IMPORTANT]
|
|
70
|
-
> When using `pie-textarea`, 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
|
-
|
|
32
|
+
Visit [Textarea | PIE Design System](https://pie.design/components/textarea) to view more information on this component.
|
|
72
33
|
|
|
73
|
-
##
|
|
34
|
+
## Questions
|
|
74
35
|
|
|
75
|
-
|
|
76
|
-
|---|---|---|---|
|
|
77
|
-
| `disabled` | `boolean` | `false`| Indicates whether or not the textarea is disabled. |
|
|
78
|
-
| `size` | `'small'`, `'medium'`, `'large'` | `'medium'` | The size of the textarea field. |
|
|
79
|
-
| `resize` | `'auto'`, `'manual'` | `'auto'` | Controls the resizing behaviour of the textarea. |
|
|
80
|
-
| `value` | `string` | `''` | The value of the textarea (used as a key/value pair in HTML forms with `name`). |
|
|
81
|
-
| `name` | `string` | `''` | The name of the textarea (used as a key/value pair with `value`). This is required in order to work properly with forms. |
|
|
82
|
-
| `autocomplete` | `string` | `''` | Allows the user to enable or disable autocomplete functionality on the textarea field. |
|
|
83
|
-
| `autoFocus` | `boolean` | `false` | If true, the textarea will be focused on the first render. |
|
|
84
|
-
| `readonly` | `boolean` | `false` | When true, the user cannot edit the control. Not the same as disabled. |
|
|
85
|
-
| `required` | `boolean` | `false` | If true, the textarea is required to have a value before submitting the form. If there is no value, then the component validity state will be invalid. |
|
|
86
|
-
|
|
87
|
-
In your markup or JSX, you can then use these to set the properties for the `pie-textarea` component:
|
|
88
|
-
|
|
89
|
-
```html
|
|
90
|
-
<!-- Native HTML -->
|
|
91
|
-
<pie-textarea></pie-textarea>
|
|
92
|
-
|
|
93
|
-
<!-- JSX -->
|
|
94
|
-
<PieTextarea></PieTextarea>
|
|
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
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@justeattakeaway/pie-textarea",
|
|
3
3
|
"description": "PIE Design System Textarea built using Web Components",
|
|
4
|
-
"version": "0.6.
|
|
4
|
+
"version": "0.6.1",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"module": "dist/index.js",
|
|
@@ -36,12 +36,13 @@
|
|
|
36
36
|
"license": "Apache-2.0",
|
|
37
37
|
"devDependencies": {
|
|
38
38
|
"@custom-elements-manifest/analyzer": "0.9.0",
|
|
39
|
-
"@justeattakeaway/pie-components-config": "0.
|
|
39
|
+
"@justeattakeaway/pie-components-config": "0.17.0",
|
|
40
|
+
"@justeattakeaway/pie-css": "0.12.1",
|
|
40
41
|
"@types/lodash.throttle": "4.1.9",
|
|
41
42
|
"cem-plugin-module-file-extensions": "0.0.5"
|
|
42
43
|
},
|
|
43
44
|
"dependencies": {
|
|
44
|
-
"@justeattakeaway/pie-form-label": "0.14.
|
|
45
|
+
"@justeattakeaway/pie-form-label": "0.14.1",
|
|
45
46
|
"@justeattakeaway/pie-webc-core": "0.24.0",
|
|
46
47
|
"lodash.throttle": "4.1.1"
|
|
47
48
|
},
|