@instructure/ui-editable 11.0.2-snapshot-1 → 11.0.2-snapshot-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.
- package/CHANGELOG.md +1 -1
- package/README.md +3 -3
- package/package.json +14 -14
- package/src/InPlaceEdit/README.md +2 -2
- package/tsconfig.build.tsbuildinfo +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
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
|
-
## [11.0.2-snapshot-
|
|
6
|
+
## [11.0.2-snapshot-2](https://github.com/instructure/instructure-ui/compare/v11.0.1...v11.0.2-snapshot-2) (2025-10-20)
|
|
7
7
|
|
|
8
8
|
**Note:** Version bump only for package @instructure/ui-editable
|
|
9
9
|
|
package/README.md
CHANGED
|
@@ -10,8 +10,8 @@ Supports in-place editing of content.
|
|
|
10
10
|
|
|
11
11
|
The `ui-editable` packages contains the following:
|
|
12
12
|
|
|
13
|
-
- [Editable](
|
|
14
|
-
- [InPlaceEdit](
|
|
13
|
+
- [Editable](Editable)
|
|
14
|
+
- [InPlaceEdit](InPlaceEdit)
|
|
15
15
|
|
|
16
16
|
### Installation
|
|
17
17
|
|
|
@@ -21,7 +21,7 @@ npm install @instructure/ui-editable
|
|
|
21
21
|
|
|
22
22
|
### Usage
|
|
23
23
|
|
|
24
|
-
For detailed usage and documentation, see [Editable](
|
|
24
|
+
For detailed usage and documentation, see [Editable](Editable).
|
|
25
25
|
|
|
26
26
|
[npm]: https://img.shields.io/npm/v/@instructure/ui-editable.svg
|
|
27
27
|
[npm-url]: https://npmjs.com/package/@instructure/ui-editable
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@instructure/ui-editable",
|
|
3
|
-
"version": "11.0.2-snapshot-
|
|
3
|
+
"version": "11.0.2-snapshot-2",
|
|
4
4
|
"description": "A UI component library made by Instructure Inc.",
|
|
5
5
|
"author": "Instructure, Inc. Engineering and Product Design",
|
|
6
6
|
"module": "./es/index.js",
|
|
@@ -23,8 +23,8 @@
|
|
|
23
23
|
},
|
|
24
24
|
"license": "MIT",
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"@instructure/ui-axe-check": "11.0.2-snapshot-
|
|
27
|
-
"@instructure/ui-babel-preset": "11.0.2-snapshot-
|
|
26
|
+
"@instructure/ui-axe-check": "11.0.2-snapshot-2",
|
|
27
|
+
"@instructure/ui-babel-preset": "11.0.2-snapshot-2",
|
|
28
28
|
"@testing-library/jest-dom": "^6.6.3",
|
|
29
29
|
"@testing-library/react": "15.0.7",
|
|
30
30
|
"@testing-library/user-event": "^14.6.1",
|
|
@@ -32,17 +32,17 @@
|
|
|
32
32
|
},
|
|
33
33
|
"dependencies": {
|
|
34
34
|
"@babel/runtime": "^7.27.6",
|
|
35
|
-
"@instructure/console": "11.0.2-snapshot-
|
|
36
|
-
"@instructure/emotion": "11.0.2-snapshot-
|
|
37
|
-
"@instructure/shared-types": "11.0.2-snapshot-
|
|
38
|
-
"@instructure/ui-a11y-content": "11.0.2-snapshot-
|
|
39
|
-
"@instructure/ui-buttons": "11.0.2-snapshot-
|
|
40
|
-
"@instructure/ui-dom-utils": "11.0.2-snapshot-
|
|
41
|
-
"@instructure/ui-flex": "11.0.2-snapshot-
|
|
42
|
-
"@instructure/ui-focusable": "11.0.2-snapshot-
|
|
43
|
-
"@instructure/ui-icons": "11.0.2-snapshot-
|
|
44
|
-
"@instructure/ui-utils": "11.0.2-snapshot-
|
|
45
|
-
"@instructure/ui-view": "11.0.2-snapshot-
|
|
35
|
+
"@instructure/console": "11.0.2-snapshot-2",
|
|
36
|
+
"@instructure/emotion": "11.0.2-snapshot-2",
|
|
37
|
+
"@instructure/shared-types": "11.0.2-snapshot-2",
|
|
38
|
+
"@instructure/ui-a11y-content": "11.0.2-snapshot-2",
|
|
39
|
+
"@instructure/ui-buttons": "11.0.2-snapshot-2",
|
|
40
|
+
"@instructure/ui-dom-utils": "11.0.2-snapshot-2",
|
|
41
|
+
"@instructure/ui-flex": "11.0.2-snapshot-2",
|
|
42
|
+
"@instructure/ui-focusable": "11.0.2-snapshot-2",
|
|
43
|
+
"@instructure/ui-icons": "11.0.2-snapshot-2",
|
|
44
|
+
"@instructure/ui-utils": "11.0.2-snapshot-2",
|
|
45
|
+
"@instructure/ui-view": "11.0.2-snapshot-2"
|
|
46
46
|
},
|
|
47
47
|
"peerDependencies": {
|
|
48
48
|
"react": ">=18 <=19",
|
|
@@ -5,7 +5,7 @@ describes: InPlaceEdit
|
|
|
5
5
|
`InPlaceEdit` provides the DOM structure to organize the components that participate
|
|
6
6
|
in in-place editing by calling the `renderViewer` and `renderEditor` _render props_
|
|
7
7
|
in the context of the containing DOM sub-tree. It also takes care of wiring up the
|
|
8
|
-
event handlers required by [`Editable`](
|
|
8
|
+
event handlers required by [`Editable`](Editable) to make the user interactions work.
|
|
9
9
|
|
|
10
10
|
As a controlled component, it is the responsibility of the consumer to maintain some data to make this work.
|
|
11
11
|
Each time `InPlaceEdit` is rendered, you must provide as props:
|
|
@@ -22,7 +22,7 @@ The edit component, as returned by the `renderEditor` property is used to collec
|
|
|
22
22
|
input. It is up to the consumer to provide the necessary properties to get the user provided value
|
|
23
23
|
(typically `onChange`), and to provide the current value.
|
|
24
24
|
|
|
25
|
-
Some components, like [Heading](
|
|
25
|
+
Some components, like [Heading](Heading) and [Text](Text) can be made editable by setting their `as` property
|
|
26
26
|
to `input` (and optionally the `type` property). The value of this approach is that the editable version
|
|
27
27
|
will render in the same style as the view, making for a nice user experience. Other transitions,
|
|
28
28
|
`Text` to `Select` or `DateTimeInput` for example, result in a wholesale change in the component's UI, and will alter
|