react-text-forge 1.2.5 → 1.2.6

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 CHANGED
@@ -43,6 +43,29 @@ export default function App() {
43
43
  }
44
44
  ```
45
45
 
46
+ Vous pouvez si vous le désirez ajouter vos propres raccourcis claviers comme ceci:
47
+
48
+ ```jsx
49
+ import React, { useState } from "react";
50
+ import ReactTextForge from "./components/ReactTextForge";
51
+
52
+ export default function App() {
53
+ const [value, setValue] = useState({});
54
+
55
+ /**
56
+ * Indiquer en clé le raccourci définit et en valeur la fonction appliqué
57
+ */
58
+ const raccourcis = {
59
+ 'Ctrl+Shift+A': () => alert('Vous avez pressé Ctrl+Shift+A !'),
60
+ 'Alt+S': () => alert('Vous avez pressé Alt+S !')
61
+ };
62
+
63
+ return (
64
+ <ReactTextForge value={value} setValue={setValue} raccourcis={raccourcis} />
65
+ );
66
+ }
67
+ ```
68
+
46
69
  ## Licence
47
70
  Ce projet est sous licence MIT.
48
71
 
@@ -4,17 +4,19 @@ export default ReactTextForge;
4
4
  *
5
5
  * @param {object} props
6
6
  * @param {object} props.value - contenu textuel
7
+ * @param {function} props.setValue - change l'état du contenu
7
8
  * @param {string} props.borderColor - couleur de bordure des éléments
8
9
  * @param {string} props.backgroundColor - couleur d'arrière-plan
9
10
  * @param {string} props.imageColor - couleur des images
10
- * @param {function} props.setValue - change l'état du contenu
11
+ * @param {object} props.raccourcis - liste des raccourcis ajoutées
11
12
  *
12
13
  * @returns {JSX.Element }
13
14
  */
14
- declare function ReactTextForge({ value, setValue, borderColor, backgroundColor, imageColor }: {
15
+ declare function ReactTextForge({ value, setValue, borderColor, backgroundColor, imageColor, raccourcis }: {
15
16
  value: object;
17
+ setValue: Function;
16
18
  borderColor: string;
17
19
  backgroundColor: string;
18
20
  imageColor: string;
19
- setValue: Function;
21
+ raccourcis: object;
20
22
  }): JSX.Element;