@akinon/pz-bkm 1.91.0 → 1.92.0-rc.7
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 +34 -1
- package/package.json +1 -1
- package/readme.md +35 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,39 @@
|
|
|
1
1
|
# @akinon/pz-bkm
|
|
2
2
|
|
|
3
|
-
## 1.
|
|
3
|
+
## 1.92.0-rc.7
|
|
4
|
+
|
|
5
|
+
## 1.91.0-rc.6
|
|
6
|
+
|
|
7
|
+
## 1.91.0-rc.5
|
|
8
|
+
|
|
9
|
+
## 1.91.0-rc.4
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- d35e8ac: ZERO-3402 :Update README.md to enhance props documentation and usage examples for customUIRender
|
|
14
|
+
- 7eb51ca: ZERO-3424 :Update package versions
|
|
15
|
+
|
|
16
|
+
## 1.91.0-rc.3
|
|
17
|
+
|
|
18
|
+
### Minor Changes
|
|
19
|
+
|
|
20
|
+
- 64699d3f: ZERO-2761: Fix invalid import for plugin module
|
|
21
|
+
- e974d8e8: ZERO-3406: Fix rc build
|
|
22
|
+
- 7727ae55: ZERO-3073: Refactor basket page to use server-side data fetching and simplify component structure
|
|
23
|
+
- 33377cfd: ZERO-3267: Refactor import statement for ROUTES in error-page component
|
|
24
|
+
|
|
25
|
+
## 1.91.0-rc.2
|
|
26
|
+
|
|
27
|
+
## 1.91.0-rc.1
|
|
28
|
+
|
|
29
|
+
## 1.91.0-rc.0
|
|
30
|
+
|
|
31
|
+
### Minor Changes
|
|
32
|
+
|
|
33
|
+
- 64699d3f: ZERO-2761: Fix invalid import for plugin module
|
|
34
|
+
- e974d8e: ZERO-3406: Fix rc build
|
|
35
|
+
- 7727ae55: ZERO-3073: Refactor basket page to use server-side data fetching and simplify component structure
|
|
36
|
+
- 33377cfd: ZERO-3267: Refactor import statement for ROUTES in error-page component
|
|
4
37
|
|
|
5
38
|
## 1.90.0
|
|
6
39
|
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -10,9 +10,41 @@ npx @akinon/projectzero@latest --plugins
|
|
|
10
10
|
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
###
|
|
13
|
+
### Props
|
|
14
|
+
|
|
15
|
+
| Property | Type | Required | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| `translations` | `object` | Optional | Object containing translation strings. |
|
|
18
|
+
| `classes` | `object` | Optional | Object containing custom CSS class names. |
|
|
19
|
+
| `customUIRender` | `React.ReactNode` | Optional | Custom rendering functions. |
|
|
20
|
+
|
|
21
|
+
### customUIRender Props
|
|
22
|
+
|
|
23
|
+
| Property | Type | Required | Description |
|
|
24
|
+
| --- | --- | --- | --- |
|
|
25
|
+
| `handleSubmit` | `UseFormHandleSubmit<BKMOptionForm>` | Required | Form submission handler from `react-hook-form`. Wraps the `handleSubmit` method. |
|
|
26
|
+
| `onSubmit` | `SubmitHandler<BKMOptionForm>` | Required | Callback function executed on successful form submission. |
|
|
27
|
+
| `control` | `Control<BKMOptionForm>` | Required | Control object used to register form inputs with `react-hook-form`. |
|
|
28
|
+
| `errors` | `FieldErrors<BKMOptionForm>` | Required | Contains validation errors for form fields. |
|
|
29
|
+
| `translations` | `BKMOptionProps['translations']` | Optional | Optional prop for providing localized strings like title and description. |
|
|
30
|
+
| `bkmFrameId` | `string` | Required | The DOM `id` attribute for the embedded BKM iframe element. |
|
|
14
31
|
|
|
15
|
-
|
|
32
|
+
### Translations Properties
|
|
33
|
+
|
|
34
|
+
| Key | Type | Description |
|
|
35
|
+
| --- | --- | --- |
|
|
36
|
+
| `title` | `string` | The title text displayed at the top of the component. |
|
|
37
|
+
| `description` | `string` | A short description or informative message for the user. |
|
|
38
|
+
| `button` | `string` | Text displayed on the submit button. |
|
|
39
|
+
| `required` | `string` | Validation message shown when a required field is empty. |
|
|
40
|
+
|
|
41
|
+
### Usage Examples
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
src/views/checkout/steps/payment/options/bkm.tsx
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
#### Default Usage
|
|
16
48
|
|
|
17
49
|
```javascript
|
|
18
50
|
const Bkm = () => {
|
|
@@ -33,15 +65,7 @@ const Bkm = () => {
|
|
|
33
65
|
export default Bkm;
|
|
34
66
|
```
|
|
35
67
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
| Property | Type | Description |
|
|
39
|
-
| --- | --- | --- |
|
|
40
|
-
| `translations` | `object` | Object containing translation strings. |
|
|
41
|
-
| `classes` | `object` | Object containing custom CSS class names. |
|
|
42
|
-
| `customUIRender` | `React.ReactNode` | Optional function to fully customize the bkm express. Receives control, errors, translations, bkmFrameId and handleSubmit props. |
|
|
43
|
-
|
|
44
|
-
### Customizing BKM Express
|
|
68
|
+
#### Customized Usage with customUIRender
|
|
45
69
|
|
|
46
70
|
```javascript
|
|
47
71
|
import PluginModule, { Component } from '@akinon/next/components/plugin-module';
|