indicator-ui 0.1.47 → 0.1.48

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 (181) hide show
  1. package/README.md +25 -25
  2. package/dist/index.css +612 -0
  3. package/dist/index.css.map +1 -1
  4. package/dist/index.js +6059 -2842
  5. package/dist/index.js.map +1 -1
  6. package/dist/scss/styles/adaptive/index.scss +142 -142
  7. package/dist/scss/styles/colors/index.scss +1 -1
  8. package/dist/scss/styles/colors/primary.scss +54 -54
  9. package/dist/scss/styles/colors/secondary.scss +12 -12
  10. package/dist/scss/styles/index.scss +2 -2
  11. package/dist/scss/styles/mixins/centerInsideContent.scss +6 -6
  12. package/dist/scss/styles/mixins/changeSvg.scss +25 -25
  13. package/dist/scss/styles/mixins/fnt-flex.scss +38 -38
  14. package/dist/scss/styles/mixins/fnt.scss +25 -25
  15. package/dist/scss/styles/mixins/hiddeScrollBar.scss +9 -9
  16. package/dist/scss/styles/mixins/index.scss +7 -7
  17. package/dist/scss/styles/mixins/modify-flex.scss +17 -17
  18. package/dist/scss/styles/mixins/modify-svg.scss +30 -30
  19. package/dist/scss/test/global.scss +82 -82
  20. package/dist/scss/ui/Buttons/styles/mixins/baseButton.scss +48 -48
  21. package/dist/scss/ui/Buttons/styles/mixins/index.scss +1 -1
  22. package/dist/scss/ui/Buttons/styles/mixins/properties/index.scss +21 -21
  23. package/dist/scss/ui/Buttons/styles/mixins/properties/large.scss +28 -28
  24. package/dist/scss/ui/Buttons/styles/mixins/properties/link-black.scss +47 -47
  25. package/dist/scss/ui/Buttons/styles/mixins/properties/link-color.scss +47 -47
  26. package/dist/scss/ui/Buttons/styles/mixins/properties/link-dark-theme.scss +47 -47
  27. package/dist/scss/ui/Buttons/styles/mixins/properties/link-gray.scss +47 -47
  28. package/dist/scss/ui/Buttons/styles/mixins/properties/medium.scss +28 -28
  29. package/dist/scss/ui/Buttons/styles/mixins/properties/primary.scss +59 -59
  30. package/dist/scss/ui/Buttons/styles/mixins/properties/secondary-color.scss +72 -72
  31. package/dist/scss/ui/Buttons/styles/mixins/properties/secondary-gray.scss +90 -90
  32. package/dist/scss/ui/Buttons/styles/mixins/properties/small.scss +28 -28
  33. package/dist/scss/ui/Buttons/styles/mixins/properties/tab-active.scss +51 -51
  34. package/dist/scss/ui/Buttons/styles/mixins/properties/tab.scss +51 -51
  35. package/dist/scss/ui/Buttons/styles/mixins/properties/tertiary-color.scss +82 -82
  36. package/dist/scss/ui/Buttons/styles/mixins/properties/tertiary-gray.scss +42 -42
  37. package/dist/scss/ui/Buttons/styles/mixins/properties/tertiary-white.scss +83 -83
  38. package/dist/scss/ui/Buttons/styles/mixins/properties/ultra.scss +28 -28
  39. package/dist/scss/ui/Buttons/styles/mixins/properties/warning-link-color.scss +44 -44
  40. package/dist/scss/ui/Buttons/styles/mixins/properties/warning-primary.scss +36 -36
  41. package/dist/scss/ui/Buttons/styles/mixins/properties/warning-secondary-color.scss +40 -40
  42. package/dist/scss/ui/CheckboxMark/styles/mixins/base.scss +30 -30
  43. package/dist/scss/ui/CheckboxMark/styles/mixins/checkbox-mark.scss +95 -95
  44. package/dist/scss/ui/CheckboxMark/styles/mixins/index.scss +2 -2
  45. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/checkbox.scss +2 -2
  46. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/checked.scss +21 -21
  47. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/correct.scss +48 -48
  48. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/disabled.scss +28 -28
  49. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/error.scss +23 -23
  50. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/incorrect.scss +48 -48
  51. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/indeterminate.scss +18 -18
  52. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/index.scss +7 -7
  53. package/dist/scss/ui/CheckboxMark/styles/mixins/properties/radio.scss +14 -14
  54. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomInputField/CustomInput.scss +125 -125
  55. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomInputField/CustomInputField.scss +32 -32
  56. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomInputField/CustomTextareaInput.scss +29 -29
  57. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomInputField/index.scss +1 -1
  58. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomInputWrapper/CustomInputWrapper.scss +54 -54
  59. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomInputWrapper/config.scss +4 -4
  60. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomOptionsInput/index.scss +47 -47
  61. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomSelectField/CustomSelectField.scss +53 -53
  62. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomSelectField/CustomSelectFieldOption.scss +50 -50
  63. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomSelectField/CustomSelectFieldViewField.scss +27 -27
  64. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomSwitchersField/CustomSwitchersField.scss +16 -16
  65. package/dist/scss/ui/FormBuilder/styles/CustomFields/CustomSwitchersField/components/option.scss +33 -33
  66. package/dist/scss/ui/FormBuilder/styles/CustomFields/index.scss +4 -4
  67. package/dist/scss/ui/InputFields/FlexField/styles/mixins/flexField.scss +150 -150
  68. package/dist/scss/ui/InputFields/InputFieldWrapper/styles/mixins/inputFieldWrapper.scss +49 -49
  69. package/dist/scss/ui/MicroButton/styles/mixins/base-button.scss +17 -17
  70. package/dist/scss/ui/MicroButton/styles/mixins/index.scss +1 -1
  71. package/dist/scss/ui/MicroButton/styles/mixins/micro-button.scss +68 -68
  72. package/dist/scss/ui/MicroButton/styles/mixins/properties/blue-light.scss +18 -18
  73. package/dist/scss/ui/MicroButton/styles/mixins/properties/color-fill.scss +20 -20
  74. package/dist/scss/ui/MicroButton/styles/mixins/properties/color-hover.scss +20 -20
  75. package/dist/scss/ui/MicroButton/styles/mixins/properties/color.scss +20 -20
  76. package/dist/scss/ui/MicroButton/styles/mixins/properties/dark.scss +18 -18
  77. package/dist/scss/ui/MicroButton/styles/mixins/properties/gray-fill.scss +20 -20
  78. package/dist/scss/ui/MicroButton/styles/mixins/properties/gray.scss +20 -20
  79. package/dist/scss/ui/MicroButton/styles/mixins/properties/index.scss +17 -17
  80. package/dist/scss/ui/MicroButton/styles/mixins/properties/light.scss +20 -20
  81. package/dist/scss/ui/MicroButton/styles/mixins/properties/red-fill.scss +20 -20
  82. package/dist/scss/ui/MicroButton/styles/mixins/properties/red-hover.scss +20 -20
  83. package/dist/scss/ui/MicroButton/styles/mixins/properties/rose.scss +20 -20
  84. package/dist/scss/ui/MicroButton/styles/mixins/properties/size-14.scss +11 -11
  85. package/dist/scss/ui/MicroButton/styles/mixins/properties/size-16.scss +11 -11
  86. package/dist/scss/ui/MicroButton/styles/mixins/properties/size-20.scss +11 -11
  87. package/dist/scss/ui/MicroButton/styles/mixins/properties/size-24.scss +11 -11
  88. package/dist/scss/ui/MicroButton/styles/mixins/properties/size-28.scss +11 -11
  89. package/dist/scss/ui/Tag/styles/properties/active.scss +15 -15
  90. package/dist/scss/ui/Tag/styles/properties/base.scss +33 -33
  91. package/dist/scss/ui/Tag/styles/properties/clicked.scss +2 -2
  92. package/dist/scss/ui/Tag/styles/properties/hover.scss +4 -4
  93. package/dist/scss/ui/Tag/styles/properties/index.scss +6 -6
  94. package/dist/scss/ui/Tag/styles/properties/large.scss +18 -18
  95. package/dist/scss/ui/Tag/styles/properties/medium.scss +18 -18
  96. package/dist/scss/ui/Tag/styles/properties/small.scss +18 -18
  97. package/dist/scss/ui/ToggleBase/styles/mixins/active.scss +12 -12
  98. package/dist/scss/ui/ToggleBase/styles/mixins/base-button.scss +8 -8
  99. package/dist/scss/ui/ToggleBase/styles/mixins/base.scss +13 -13
  100. package/dist/scss/ui/ToggleBase/styles/mixins/disabled.scss +5 -5
  101. package/dist/scss/ui/ToggleBase/styles/mixins/error.scss +6 -6
  102. package/dist/scss/ui/ToggleBase/styles/mixins/hover.scss +22 -22
  103. package/dist/scss/ui/ToggleBase/styles/mixins/index.scss +8 -8
  104. package/dist/scss/ui/ToggleBase/styles/mixins/large.scss +8 -8
  105. package/dist/scss/ui/ToggleBase/styles/mixins/medium.scss +8 -8
  106. package/dist/scss/ui/ToggleBase/styles/mixins/spacer.scss +4 -4
  107. package/dist/scss/ui/formFields/FormFieldWrapper/styles/mixins/index.scss +1 -0
  108. package/dist/scss/ui/formFields/FormFieldWrapper/styles/mixins/inputFieldWrapper.scss +50 -0
  109. package/dist/types/src/hooks/forms/__tests__/lib/getDataByPath.test.d.ts +1 -0
  110. package/dist/types/src/hooks/forms/__tests__/lib/getFormDataPaths.test.d.ts +1 -0
  111. package/dist/types/src/hooks/forms/__tests__/lib/setDataByPath.test.d.ts +1 -0
  112. package/dist/types/src/hooks/forms/__tests__/lib/utils.test.d.ts +1 -0
  113. package/dist/types/src/hooks/forms/classes/index.d.ts +44 -0
  114. package/dist/types/src/hooks/forms/index.d.ts +2 -0
  115. package/dist/types/src/hooks/forms/lib/fieldsProps.d.ts +11 -0
  116. package/dist/types/src/hooks/forms/lib/getDataByPath.d.ts +4 -0
  117. package/dist/types/src/hooks/forms/lib/getFormDataPaths.d.ts +5 -0
  118. package/dist/types/src/hooks/forms/lib/index.d.ts +5 -0
  119. package/dist/types/src/hooks/forms/lib/scheme.d.ts +13 -0
  120. package/dist/types/src/hooks/forms/lib/setDataByPath.d.ts +5 -0
  121. package/dist/types/src/hooks/forms/lib/utils.d.ts +9 -0
  122. package/dist/types/src/hooks/forms/types/formTypes.d.ts +51 -0
  123. package/dist/types/src/hooks/forms/types/index.d.ts +2 -3
  124. package/dist/types/src/hooks/forms/types/scheme.d.ts +151 -0
  125. package/dist/types/src/hooks/forms/useForm.d.ts +212 -0
  126. package/dist/types/src/hooks/forms/validateFunctions/config.d.ts +2 -0
  127. package/dist/types/src/hooks/forms/validateFunctions/index.d.ts +8 -0
  128. package/dist/types/src/hooks/forms/validateFunctions/validateArray.d.ts +1 -0
  129. package/dist/types/src/hooks/forms/validateFunctions/validateDateTime.d.ts +7 -0
  130. package/dist/types/src/hooks/forms/validateFunctions/validateEqualsTo.d.ts +1 -0
  131. package/dist/types/src/hooks/forms/validateFunctions/validateFile.d.ts +3 -0
  132. package/dist/types/src/hooks/forms/validateFunctions/validateNum.d.ts +6 -0
  133. package/dist/types/src/hooks/forms/validateFunctions/validateRequired.d.ts +1 -0
  134. package/dist/types/src/hooks/forms/validateFunctions/validateStr.d.ts +8 -0
  135. package/dist/types/src/hooks/index.d.ts +1 -0
  136. package/dist/types/src/lib/tsCheck/index.d.ts +1 -0
  137. package/dist/types/src/test/pages/FormPage.d.ts +1 -0
  138. package/dist/types/src/test/pages/index.d.ts +1 -0
  139. package/dist/types/src/types/mixins.d.ts +10 -0
  140. package/dist/types/src/ui/formFields/FormField/index.d.ts +1 -0
  141. package/dist/types/src/ui/formFields/FormField/styles/index.d.ts +1 -0
  142. package/dist/types/src/ui/formFields/FormField/ui/FormField.d.ts +6 -0
  143. package/dist/types/src/ui/formFields/FormField/ui/FormFieldBase.d.ts +19 -0
  144. package/dist/types/src/ui/formFields/FormField/ui/index.d.ts +2 -0
  145. package/dist/types/src/ui/formFields/FormFieldWrapper/index.d.ts +1 -0
  146. package/dist/types/src/ui/formFields/FormFieldWrapper/styles/index.d.ts +1 -0
  147. package/dist/types/src/ui/formFields/FormFieldWrapper/ui/FormFieldWrapper.d.ts +24 -0
  148. package/dist/types/src/ui/formFields/FormFieldWrapper/ui/index.d.ts +1 -0
  149. package/dist/types/src/ui/formFields/FormRadioField/index.d.ts +1 -0
  150. package/dist/types/src/ui/formFields/FormRadioField/ui/FieldItem.d.ts +11 -0
  151. package/dist/types/src/ui/formFields/FormRadioField/ui/FormRadioField.d.ts +18 -0
  152. package/dist/types/src/ui/formFields/FormRadioField/ui/index.d.ts +1 -0
  153. package/dist/types/src/ui/formFields/FormSelectField/config/index.d.ts +1 -0
  154. package/dist/types/src/ui/formFields/FormSelectField/index.d.ts +1 -0
  155. package/dist/types/src/ui/formFields/FormSelectField/styles/index.d.ts +1 -0
  156. package/dist/types/src/ui/formFields/FormSelectField/ui/FormSelectField.d.ts +8 -0
  157. package/dist/types/src/ui/formFields/FormSelectField/ui/FormSelectFieldBase.d.ts +21 -0
  158. package/dist/types/src/ui/formFields/FormSelectField/ui/index.d.ts +2 -0
  159. package/dist/types/src/ui/formFields/FormSwitcherField/index.d.ts +1 -0
  160. package/dist/types/src/ui/formFields/FormSwitcherField/ui/FormSwitcherField.d.ts +5 -0
  161. package/dist/types/src/ui/formFields/FormSwitcherField/ui/index.d.ts +1 -0
  162. package/dist/types/src/ui/formFields/FormTextareaField/index.d.ts +1 -0
  163. package/dist/types/src/ui/formFields/FormTextareaField/styles/index.d.ts +1 -0
  164. package/dist/types/src/ui/formFields/FormTextareaField/ui/FormTextareaField.d.ts +14 -0
  165. package/dist/types/src/ui/formFields/FormTextareaField/ui/index.d.ts +1 -0
  166. package/dist/types/src/ui/formFields/extends/index.d.ts +1 -0
  167. package/dist/types/src/ui/formFields/extends/style/index.d.ts +2 -0
  168. package/dist/types/src/ui/formFields/extends/ui/DropdownArrow.d.ts +6 -0
  169. package/dist/types/src/ui/formFields/extends/ui/InputInnerButton.d.ts +7 -0
  170. package/dist/types/src/ui/formFields/extends/ui/index.d.ts +2 -0
  171. package/dist/types/src/ui/formFields/index.d.ts +6 -0
  172. package/dist/types/src/ui/index.d.ts +1 -0
  173. package/docs/CSSVariables/CSSVariables.md +62 -62
  174. package/docs/CSSVariables/CSSVariablesCalifornia.md +61 -61
  175. package/docs/ForDev.md +106 -106
  176. package/docs/FormBuilderDocs.md +204 -204
  177. package/docs/Notes.md +189 -55
  178. package/docs/SCSSVariables.md +28 -28
  179. package/package.json +2 -2
  180. package/dist/scss/ui/InputFields/index.scss +0 -7
  181. package/dist/types/src/hooks/forms/useForms.d.ts +0 -3
@@ -0,0 +1,8 @@
1
+ import React from "react";
2
+ import { ComponentRefType } from "../../../../../../types";
3
+ import { FormSelectFieldBase } from './FormSelectFieldBase';
4
+ import { FormFieldWrapper } from '../../FormFieldWrapper';
5
+ type RefType = ComponentRefType<typeof FormFieldWrapper>;
6
+ type PropsType<D, M extends boolean> = React.ComponentProps<typeof FormSelectFieldBase<D, M>> & React.ComponentProps<typeof FormFieldWrapper>;
7
+ export declare const FormSelectField: <D, M extends boolean = false>(props: PropsType<D, M> & React.RefAttributes<RefType>) => React.ReactElement | null;
8
+ export {};
@@ -0,0 +1,21 @@
1
+ import React from "react";
2
+ import { FieldPropsType } from "../../../../hooks";
3
+ import { DropdownItemPropsType } from "../../../../ui";
4
+ import { FormFieldBase } from '../../FormField';
5
+ type SelectFieldOptionsExtendItemType<T> = DropdownItemPropsType & {
6
+ value: T;
7
+ label?: string;
8
+ };
9
+ type SelectFieldOptionsItemType<T> = SelectFieldOptionsExtendItemType<T> | T;
10
+ type SelectFieldOptionsType<T> = Array<SelectFieldOptionsItemType<T>>;
11
+ type SelectFieldValueType<D, M> = M extends true ? Array<D> : D;
12
+ type BasePropsType<D, M extends boolean> = {
13
+ options?: SelectFieldOptionsType<D>;
14
+ multiple?: M;
15
+ theme?: "light" | "dark";
16
+ disabled?: boolean;
17
+ required?: boolean;
18
+ };
19
+ type PropsType<D, M extends boolean> = Omit<React.ComponentProps<typeof FormFieldBase>, keyof BasePropsType<D, M> | keyof FieldPropsType<SelectFieldValueType<D, M>>> & FieldPropsType<SelectFieldValueType<D, M>> & BasePropsType<D, M>;
20
+ export declare function FormSelectFieldBase<D, M extends boolean = false>(props: PropsType<D, M>): import("react/jsx-runtime").JSX.Element;
21
+ export {};
@@ -0,0 +1,2 @@
1
+ export * from './FormSelectFieldBase';
2
+ export * from './FormSelectField';
@@ -0,0 +1 @@
1
+ export * from './ui';
@@ -0,0 +1,5 @@
1
+ import { TogglePropsType } from "../../../../ui";
2
+ import { FieldPropsType } from "../../../../hooks";
3
+ type PropsType = Omit<TogglePropsType, keyof FieldPropsType<boolean>> & FieldPropsType<boolean>;
4
+ export declare function FormSwitcherField(props: PropsType): JSX.Element;
5
+ export {};
@@ -0,0 +1 @@
1
+ export * from './FormSwitcherField';
@@ -0,0 +1 @@
1
+ export * from './ui';
@@ -0,0 +1 @@
1
+ export { default as TextareaFieldStyle } from './TextareaField.module.scss';
@@ -0,0 +1,14 @@
1
+ import React from "react";
2
+ import { FieldPropsType } from "../../../../hooks";
3
+ type BasePropsType = FieldPropsType<string> & {
4
+ /**
5
+ * Изменяет размер текстового поля, если текст не помещается.
6
+ *
7
+ * По умолчанию: ```false```
8
+ * */
9
+ autoResize?: boolean;
10
+ theme?: "light" | "dark";
11
+ };
12
+ type PropsType = Omit<React.ComponentProps<'textarea'>, keyof BasePropsType> & BasePropsType;
13
+ export declare function FormTextareaField(props: PropsType): import("react/jsx-runtime").JSX.Element;
14
+ export {};
@@ -0,0 +1 @@
1
+ export * from './FormTextareaField';
@@ -0,0 +1 @@
1
+ export * from './ui';
@@ -0,0 +1,2 @@
1
+ export { default as DropdownArrowStyle } from './DropdownArrow.module.scss';
2
+ export { default as InputInnerButtonStyle } from './InputInnerButton.module.scss';
@@ -0,0 +1,6 @@
1
+ import React from "react";
2
+ type PropsType = React.ComponentProps<'button'> & {
3
+ open?: boolean;
4
+ };
5
+ export declare function DropdownArrow(props: PropsType): import("react/jsx-runtime").JSX.Element;
6
+ export {};
@@ -0,0 +1,7 @@
1
+ import React from "react";
2
+ type PropsType = React.ComponentProps<'button'> & {
3
+ icon: React.ReactNode;
4
+ color: 'gray' | 'red';
5
+ };
6
+ export declare function InputInnerButton(props: PropsType): import("react/jsx-runtime").JSX.Element;
7
+ export {};
@@ -0,0 +1,2 @@
1
+ export * from './DropdownArrow';
2
+ export * from './InputInnerButton';
@@ -0,0 +1,6 @@
1
+ export * from './FormField';
2
+ export * from './FormSelectField';
3
+ export * from './FormFieldWrapper';
4
+ export * from './FormSwitcherField';
5
+ export * from './FormRadioField';
6
+ export * from './FormTextareaField';
@@ -25,3 +25,4 @@ export * from './PlayButton';
25
25
  export * from './DateTimePicker';
26
26
  export * from './Tooltip';
27
27
  export * from './Dropdown';
28
+ export * from './formFields';
@@ -1,63 +1,63 @@
1
- [🔙 Назад](../../README.md)
2
-
3
- # CSS Variables
4
-
5
- В библиотеке используются **CSS-переменные** для цветов (в будущем, возможно, не только для них). Иногда может возникнуть необходимость изменить эти значения в вашем проекте.
6
-
7
- ---
8
-
9
- ## 🔧 Использование в разработке
10
-
11
- Для задания переменных в библиотеке используются **CSS Variables**, все переменные лучше складировать в файлах по типу `*-var.scss`:
12
-
13
- ```css
14
- :root {
15
- --var: #fff;
16
- }
17
- ```
18
-
19
- При использовании в стилях:
20
-
21
- ```scss
22
- @use 'variables' as *;
23
-
24
- background-color: var(--var);
25
- ```
26
-
27
- 📌 **Важно**: при разработке новых компонентов в библиотеке используйте **только** CSS-переменные, чтобы пользователи могли их переопределять в своих проектах.
28
-
29
- ---
30
-
31
- ## 🎨 Кастомизация в проекте
32
-
33
- ### 1️⃣ Создайте файл с переопределением переменных
34
-
35
- Рекомендуется создать отдельный файл (например, `indicator-ui-variables.scss`), в котором будут переопределены значения CSS-переменных библиотеки. Все новые переменные должны находиться в `:root {}`.
36
-
37
- Пример:
38
-
39
- ```scss
40
- :root {
41
- --base-black: #000000;
42
- --base-white: #ffffff;
43
- /* Другие цвета */
44
- }
45
- ```
46
-
47
- 🔹 _(Автор не расист, все вопросы к [Rockstar](https://support.rockstargames.com/), так как цитата взята оттуда)_ 😁
48
-
49
- ### 2️⃣ Импортируйте файл с переменными
50
-
51
- Чтобы переопределенные переменные применились корректно, **импортируйте их после подключения библиотеки**:
52
-
53
- ```scss
54
- @import 'indicator-ui/dist/index.css';
55
- @import 'indicator-ui-variables.scss';
56
- ```
57
-
58
- 🎉 **Ура, победа. Вы переопределили переменные в библиотеке.**
59
-
60
-
61
- ## PS
62
-
1
+ [🔙 Назад](../../README.md)
2
+
3
+ # CSS Variables
4
+
5
+ В библиотеке используются **CSS-переменные** для цветов (в будущем, возможно, не только для них). Иногда может возникнуть необходимость изменить эти значения в вашем проекте.
6
+
7
+ ---
8
+
9
+ ## 🔧 Использование в разработке
10
+
11
+ Для задания переменных в библиотеке используются **CSS Variables**, все переменные лучше складировать в файлах по типу `*-var.scss`:
12
+
13
+ ```css
14
+ :root {
15
+ --var: #fff;
16
+ }
17
+ ```
18
+
19
+ При использовании в стилях:
20
+
21
+ ```scss
22
+ @use 'variables' as *;
23
+
24
+ background-color: var(--var);
25
+ ```
26
+
27
+ 📌 **Важно**: при разработке новых компонентов в библиотеке используйте **только** CSS-переменные, чтобы пользователи могли их переопределять в своих проектах.
28
+
29
+ ---
30
+
31
+ ## 🎨 Кастомизация в проекте
32
+
33
+ ### 1️⃣ Создайте файл с переопределением переменных
34
+
35
+ Рекомендуется создать отдельный файл (например, `indicator-ui-variables.scss`), в котором будут переопределены значения CSS-переменных библиотеки. Все новые переменные должны находиться в `:root {}`.
36
+
37
+ Пример:
38
+
39
+ ```scss
40
+ :root {
41
+ --base-black: #000000;
42
+ --base-white: #ffffff;
43
+ /* Другие цвета */
44
+ }
45
+ ```
46
+
47
+ 🔹 _(Автор не расист, все вопросы к [Rockstar](https://support.rockstargames.com/), так как цитата взята оттуда)_ 😁
48
+
49
+ ### 2️⃣ Импортируйте файл с переменными
50
+
51
+ Чтобы переопределенные переменные применились корректно, **импортируйте их после подключения библиотеки**:
52
+
53
+ ```scss
54
+ @import 'indicator-ui/dist/index.css';
55
+ @import 'indicator-ui-variables.scss';
56
+ ```
57
+
58
+ 🎉 **Ура, победа. Вы переопределили переменные в библиотеке.**
59
+
60
+
61
+ ## PS
62
+
63
63
  [Если интересно, как выглядила бы документация, если ее автор был из Калифорнии](./CSSVariablesCalifornia.md)
@@ -1,62 +1,62 @@
1
- [🔙 Назад](../../README.md)
2
-
3
- # CSS Variables 🌴🌊
4
-
5
- Йооо, чуваки, в этой библиотеке мы юзаем **CSS-переменные** для цветов (ну, возможно, в будущем не только для них, кто знает). Иногда захочешь немного покрутить их под свой проект, и вот тебе, как это сделать, если хочешь, чтобы всё было чётко! ✌️
6
-
7
- ---
8
-
9
- ## 🔧 Как это работает, чувак?
10
-
11
- Мы задаем переменные в библиотеке через **CSS Variables**:
12
-
13
- ```css
14
- :root {
15
- --var: #fff; /* Ну типа белый цвет, да */
16
- }
17
- ```
18
-
19
- А когда хочешь использовать эту штуку, просто пиши так:
20
-
21
- ```scss
22
- @use 'variables' as *;
23
-
24
- background-color: var(--var); /* Эй, хватит смотреть на меня, ты ж знаешь, что это делает */
25
- ```
26
-
27
- 📌 **Тупо важно**: Когда ты делаешь новые компоненты для библиотеки, **используй только** CSS-переменные, чтобы другие ребята могли под себя всё настроить. Просто чётко, понял? 😎
28
-
29
- ---
30
-
31
- ## 🎨 Как настроить свой проект, чувак?
32
-
33
- ### 1️⃣ Создай файл, где ты всё переделаешь
34
-
35
- Эй, не усложняй, просто создай отдельный файл (например, `indicator-ui-variables.scss`), где будешь переделывать эти переменные на свой вкус. Все твои новые переменные должны быть в `:root {}`. Это как твоя домашка, только тут можно реально кайфануть. 😁
36
-
37
- Пример, ну типа так:
38
-
39
- ```scss
40
- :root {
41
- --base-black: #000000; /* Ну ты понял, базовый чёрный */
42
- --base-white: #ffffff; /* Базовый белый, чтоб не скучно было */
43
- /* Добавь что хочешь — зелёный для своей ласточки или оранжевый для веселья */
44
- }
45
- ```
46
-
47
- 🔹 _(Не переживай, я не расист, всё как-то так у Rockstar вон, если что 😜)_
48
-
49
- ### 2️⃣ Импортируй файл с переменными
50
-
51
- Чувак, вот тут важный момент — тебе нужно импортировать твой файл **после** подключения самой библиотеки, иначе, ну, как бы, не прокатит. Это как печеньки после молока, понял? 😋
52
-
53
- ```scss
54
- @import 'indicator-ui/dist/index.css';
55
- @import 'indicator-ui-variables.scss'; /* И вот тут ты подключаешь свои переменные */
56
- ```
57
-
58
- 🎉 **Йо! Ты переопределил переменные в библиотеке, теперь ты как бог в своём проекте.** 🔥
59
-
60
- ---
61
-
1
+ [🔙 Назад](../../README.md)
2
+
3
+ # CSS Variables 🌴🌊
4
+
5
+ Йооо, чуваки, в этой библиотеке мы юзаем **CSS-переменные** для цветов (ну, возможно, в будущем не только для них, кто знает). Иногда захочешь немного покрутить их под свой проект, и вот тебе, как это сделать, если хочешь, чтобы всё было чётко! ✌️
6
+
7
+ ---
8
+
9
+ ## 🔧 Как это работает, чувак?
10
+
11
+ Мы задаем переменные в библиотеке через **CSS Variables**:
12
+
13
+ ```css
14
+ :root {
15
+ --var: #fff; /* Ну типа белый цвет, да */
16
+ }
17
+ ```
18
+
19
+ А когда хочешь использовать эту штуку, просто пиши так:
20
+
21
+ ```scss
22
+ @use 'variables' as *;
23
+
24
+ background-color: var(--var); /* Эй, хватит смотреть на меня, ты ж знаешь, что это делает */
25
+ ```
26
+
27
+ 📌 **Тупо важно**: Когда ты делаешь новые компоненты для библиотеки, **используй только** CSS-переменные, чтобы другие ребята могли под себя всё настроить. Просто чётко, понял? 😎
28
+
29
+ ---
30
+
31
+ ## 🎨 Как настроить свой проект, чувак?
32
+
33
+ ### 1️⃣ Создай файл, где ты всё переделаешь
34
+
35
+ Эй, не усложняй, просто создай отдельный файл (например, `indicator-ui-variables.scss`), где будешь переделывать эти переменные на свой вкус. Все твои новые переменные должны быть в `:root {}`. Это как твоя домашка, только тут можно реально кайфануть. 😁
36
+
37
+ Пример, ну типа так:
38
+
39
+ ```scss
40
+ :root {
41
+ --base-black: #000000; /* Ну ты понял, базовый чёрный */
42
+ --base-white: #ffffff; /* Базовый белый, чтоб не скучно было */
43
+ /* Добавь что хочешь — зелёный для своей ласточки или оранжевый для веселья */
44
+ }
45
+ ```
46
+
47
+ 🔹 _(Не переживай, я не расист, всё как-то так у Rockstar вон, если что 😜)_
48
+
49
+ ### 2️⃣ Импортируй файл с переменными
50
+
51
+ Чувак, вот тут важный момент — тебе нужно импортировать твой файл **после** подключения самой библиотеки, иначе, ну, как бы, не прокатит. Это как печеньки после молока, понял? 😋
52
+
53
+ ```scss
54
+ @import 'indicator-ui/dist/index.css';
55
+ @import 'indicator-ui-variables.scss'; /* И вот тут ты подключаешь свои переменные */
56
+ ```
57
+
58
+ 🎉 **Йо! Ты переопределил переменные в библиотеке, теперь ты как бог в своём проекте.** 🔥
59
+
60
+ ---
61
+
62
62
  Теперь ты точно в игре! Не забывай — кастомизация это твоя фишка, а библиотека — твой инструмент. Давай, чувак, делай всё по-своему и кайфуй! 🌞🌴
package/docs/ForDev.md CHANGED
@@ -1,106 +1,106 @@
1
- [🔙 Назад](../README.md)
2
-
3
- # 📌 Для разработки
4
-
5
- ---
6
-
7
- ## 🔥 Точки входа
8
-
9
- В проекте есть два ключевых входа для модулей — **js/ts** и **scss**.
10
-
11
- #### 📂 `src/index.ts` (js/ts модули)
12
-
13
- Добавляем сюда все модули, которые должны быть доступны через:
14
-
15
- ```ts
16
- import {} from 'indicator-ui';
17
- ```
18
-
19
- #### 🎨 `src/index.scss` (scss модули)
20
-
21
- Добавляем сюда все стили, которые должны быть доступны через:
22
-
23
- ```scss
24
- @use 'indicator-ui' as *;
25
- ```
26
-
27
- ---
28
-
29
- ## ⚙️ Сборка проекта
30
-
31
- Чтобы собрать проект, используйте:
32
-
33
- ```sh
34
- npm run lib:build
35
- ```
36
-
37
- Результаты сборки появятся в папке `dist`. Там, возможно, живёт магия. 🧙‍♂️✨
38
-
39
- ---
40
-
41
- ## 🧪 Тестирование во время разработки
42
-
43
- Для быстрого тестирования и проверки работы библиотеки используйте **React приложение** в папке с исходным кодом. Оно
44
- доступно по следующему пути:
45
-
46
- **[Жмак](../src/test/index.tsx)**
47
-
48
- В этом приложении настроен роутинг с несколькими страницами. Для тестирования просто добавляйте нужные элементы и
49
- страницы, следуя шаблону.
50
-
51
- Для добавления страниц в роутинг откройте и отредактируйте файл:
52
-
53
- **[Жмyк](../src/test/App.tsx)**
54
-
55
- ### 🏃‍♂️ Запуск dev-сервера
56
-
57
- Чтобы запустить локальный сервер для разработки, выполните команду:
58
-
59
- ```sh
60
- npm run dev:dev
61
- ```
62
-
63
- **Важно:** Стремитесь создавать страницы, максимально приближенные к финальному дизайну, чтобы дизайнер мог проверить
64
- вашу работу в реальном времени и удостовериться, что она соответствует его ожиданиям.
65
-
66
- ## 🛠 Тестирование перед публикацией
67
-
68
- Перед публикацией можно протестировать библиотеку на локальном **React**-проекте `test-project`. Для этого используется
69
- **yalc** — аналог npm, но для локальных пакетов.
70
-
71
- ### 🚀 Установка `yalc`
72
-
73
- ```sh
74
- npm install -g yalc
75
- ```
76
-
77
- ### 📦 Публикация в локальное хранилище
78
-
79
- ```sh
80
- yalc publish
81
- ```
82
-
83
- Есть вторая команда, которая по идее должна еще и обновлять библу, где она используется.
84
-
85
- ```sh
86
- yalc publish --push
87
- ```
88
-
89
- ### 📥 Установка библиотеки в проект
90
-
91
- ```sh
92
- yalc add indicator-ui
93
- ```
94
-
95
- ### 🔄 Обновление библиотеки
96
-
97
- ```sh
98
- yalc update
99
- ```
100
-
101
- Также советую делать удаление библы, так как `yalc` и `npm` очень странно работают и иногда могут добавлять изменения.
102
-
103
- ```sh
104
- npm uninstall indicator-ui
105
- ```
106
-
1
+ [🔙 Назад](../README.md)
2
+
3
+ # 📌 Для разработки
4
+
5
+ ---
6
+
7
+ ## 🔥 Точки входа
8
+
9
+ В проекте есть два ключевых входа для модулей — **js/ts** и **scss**.
10
+
11
+ #### 📂 `src/index.ts` (js/ts модули)
12
+
13
+ Добавляем сюда все модули, которые должны быть доступны через:
14
+
15
+ ```ts
16
+ import {} from 'indicator-ui';
17
+ ```
18
+
19
+ #### 🎨 `src/index.scss` (scss модули)
20
+
21
+ Добавляем сюда все стили, которые должны быть доступны через:
22
+
23
+ ```scss
24
+ @use 'indicator-ui' as *;
25
+ ```
26
+
27
+ ---
28
+
29
+ ## ⚙️ Сборка проекта
30
+
31
+ Чтобы собрать проект, используйте:
32
+
33
+ ```sh
34
+ npm run lib:build
35
+ ```
36
+
37
+ Результаты сборки появятся в папке `dist`. Там, возможно, живёт магия. 🧙‍♂️✨
38
+
39
+ ---
40
+
41
+ ## 🧪 Тестирование во время разработки
42
+
43
+ Для быстрого тестирования и проверки работы библиотеки используйте **React приложение** в папке с исходным кодом. Оно
44
+ доступно по следующему пути:
45
+
46
+ **[Жмак](../src/test/index.tsx)**
47
+
48
+ В этом приложении настроен роутинг с несколькими страницами. Для тестирования просто добавляйте нужные элементы и
49
+ страницы, следуя шаблону.
50
+
51
+ Для добавления страниц в роутинг откройте и отредактируйте файл:
52
+
53
+ **[Жмyк](../src/test/App.tsx)**
54
+
55
+ ### 🏃‍♂️ Запуск dev-сервера
56
+
57
+ Чтобы запустить локальный сервер для разработки, выполните команду:
58
+
59
+ ```sh
60
+ npm run dev:dev
61
+ ```
62
+
63
+ **Важно:** Стремитесь создавать страницы, максимально приближенные к финальному дизайну, чтобы дизайнер мог проверить
64
+ вашу работу в реальном времени и удостовериться, что она соответствует его ожиданиям.
65
+
66
+ ## 🛠 Тестирование перед публикацией
67
+
68
+ Перед публикацией можно протестировать библиотеку на локальном **React**-проекте `test-project`. Для этого используется
69
+ **yalc** — аналог npm, но для локальных пакетов.
70
+
71
+ ### 🚀 Установка `yalc`
72
+
73
+ ```sh
74
+ npm install -g yalc
75
+ ```
76
+
77
+ ### 📦 Публикация в локальное хранилище
78
+
79
+ ```sh
80
+ yalc publish
81
+ ```
82
+
83
+ Есть вторая команда, которая по идее должна еще и обновлять библу, где она используется.
84
+
85
+ ```sh
86
+ yalc publish --push
87
+ ```
88
+
89
+ ### 📥 Установка библиотеки в проект
90
+
91
+ ```sh
92
+ yalc add indicator-ui
93
+ ```
94
+
95
+ ### 🔄 Обновление библиотеки
96
+
97
+ ```sh
98
+ yalc update
99
+ ```
100
+
101
+ Также советую делать удаление библы, так как `yalc` и `npm` очень странно работают и иногда могут добавлять изменения.
102
+
103
+ ```sh
104
+ npm uninstall indicator-ui
105
+ ```
106
+