fsk-design-system 1.0.18 → 1.0.20

package/README.md

@@ -1,24 +1,62 @@
-# FSK Design System
+# 💠 FSK Design System
 
-Универсальная дизайн-система с поддержкой тем и кастомных UI-компонентов.
+[![npm version](https://img.shields.io/npm/v/fsk-design-system.svg?style=flat-square&color=blue)](https://www.npmjs.com/package/fsk-design-system)
 
-## 📦 Установка
+Универсальная **дизайн-система** с поддержкой тем, типизацией и кастомных UI-компонентов на базе **Ant Design** и **Emotion**
+
+---
+
+## 📦 Требования и установка
+
+### 1. Основной пакет
 
 ```bash
 npm install fsk-design-system
 ```
 
+### 2. Обязательные зависимости
+
+> 💡 Если в вашем проекте они уже установлены — этот шаг можно пропустить.
+
+```json
+"dependencies": {
+  "antd": ">=5.27.4 <6.0.0",
+  "react": ">=18.3.1 <19.0.0",
+  "react-dom": ">=18.3.1 <19.0.0"
+}
+```
+
+#### npm
+
+```bash
+npm install antd@5.27.4 react@18.3.1 react-dom@18.3.1
+```
+
+#### yarn
+
+```bash
+yarn add antd@5.27.4 react@18.3.1 react-dom@18.3.1
+```
+
+#### pnpm
+
+```bash
+pnpm add antd@5.27.4 react@18.3.1 react-dom@18.3.1
+```
+
 ## ⚡ Быстрый старт
 
-1. **Импортируйте стили дизайн-системы в корневом файле:**
+#### 1️⃣ Импортируйте стили
 
 ```ts
 import 'fsk-design-system/styles.css';
 ```
 
-2. **Оберните приложение в `ThemeProvider`:**
+#### 2️⃣ Оберните приложение в `ThemeProvider`
 
 ```tsx
+import 'fsk-design-system/styles.css';
+
 import { ThemeProvider } from 'fsk-design-system';
 
 const App = () => (
@@ -28,20 +66,42 @@ const App = () => (
 );
 ```
 
-3. **Оберните приложение в `ConfigProvider` для русификации:**
+#### 3️⃣ Подключите `NotificationProvider`
 
 ```tsx
-import ConfigProvider from "antd/es/config-provider"
-import ruRU from "antd/locale/ru_RU"
+import { ThemeProvider, NotificationProvider, useNotification, Button } from 'fsk-design-system';
 
 const App = () => (
-  <ConfigProvider locale={ruRU}>
-    {/* Ваш код */}
-  </ConfigProvider>
+  <ThemeProvider>
+    <NotificationProvider>
+      <Component />
+    </NotificationProvider>
+  </ThemeProvider>
 );
+
+const Component = () => {
+  const notify = useNotification()
+
+  return (
+    <Button onClick={() => notify.success({ message: "Данные успешно обновлены" })}>
+      Сохранить
+    </Button>
+  )
+};
 ```
 
-## 🔹 Смена темы через хук `useTheme`
+## 🧩 Примеры компонентов
+
+📚 Полный список компонентов доступен в [Storybook](https://design-system.k8s-dev.fsk.ru/)
+
+```tsx
+import { Button, Input } from 'fsk-design-system';
+
+<Button size="l" type="main-primary">Click me</Button>
+<Input label="Email" placeholder="example@mail.com" />
+```
+
+## 🌗 Управление темой
 
 ```tsx
 import { useTheme } from 'fsk-design-system';
@@ -57,40 +117,45 @@ const ThemeSwitcher = () => {
 };
 ```
 
-## 🎨 Доступные темы
+### 🎨 Доступные темы
 
-| Название темы | Описание       |
+| Тема          | Описание       |
 |---------------|----------------|
 | `light`       | Светлая тема (по умолчанию) |
 | `dark`        | Тёмная тема    |
 
-## 🧩 Компоненты
+## 🪶 Иконки
 
-> Полный список компонентов — см. в [документации](https://design-system.k8s-dev.fsk.ru/)
+Иконки взяты из библиотеки [solar-icons](https://solar-icons.vercel.app/icons)
 
 Пример:
 
 ```tsx
-import { Button } from 'fsk-design-system';
+import { InfoCircle } from 'fsk-design-system/icons';
 
-<Button size="xl" type="main-secondary">Click me</Button>
+<Button icon={<InfoCircle weight="Outline" />}>Button</Button>
 ```
 
-## 📌 Требования
+Лучше использовать всегда одну и ту же иконку для разных направлений
 
-```json
-"dependencies": {
-  "@emotion/css": "^11.13.5",
-  "@emotion/react": "^11.13.3",
-  "@emotion/styled": "^11.13.0",
-  "antd": "^5.23.4",
-  "react": "^18.3.1",
-  "react-dom": "^18.3.1"
-}
-```
+Пример:
 
-```bash
-npm install @emotion/css@^11.13.5 @emotion/react@^11.13.3 @emotion/styled@^11.13.0 antd@^5.23.4 react@^18.3.1 react-dom@^18.3.1
+```tsx
+// Вместо:
+import { ArrowDown, ArrowLeft, ArrowRight, ArrowUp } from 'fsk-design-system/icons';
+
+<ArrowDown />
+<ArrowLeft />
+<ArrowUp />
+<ArrowRight />
+
+// Лучше так:
+import { ArrowDown } from 'fsk-design-system/icons';
+
+<ArrowDown /> // стрелка вниз
+<ArrowDown style={{ transform: "rotate(90deg)" }}  /> // стрелка влево
+<ArrowDown style={{ transform: "rotate(180deg)" }}  /> // стрелка вверх
+<ArrowDown style={{ transform: "rotate(-90deg)" }}  /> // стрелка вправо
 ```
 
 ---

package/components.d.ts

@@ -0,0 +1 @@
+export * from "./dist/components/index"

package/dist/assets/fonts/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2019 The Golos Text Project Authors (https://github.com/googlefonts/golos-text)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/assets/fonts/golos-text/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2019 The Golos Text Project Authors (https://github.com/googlefonts/golos-text)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.