@dxtmisha/wiki 0.57.3 → 0.57.6

package/src/media/functional/figma/functions/sendClientStorage/sendClientStorage.vi.mdx

@@ -0,0 +1,29 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/figma/Functions/sendClientStorage - Lưu dữ liệu vào bộ nhớ client'/>
+
+# `sendClientStorage`
+
+Một tiện ích để lưu dữ liệu vào bộ nhớ client (`clientStorage`) của Figma. Nó gửi một tin nhắn từ giao diện người dùng (UI) đến phía plugin để lưu trữ giá trị được cung cấp dưới một tên cụ thể.
+
+**Tham số:**
+- `name: string` — Tên khóa trong bộ nhớ client.
+- `value: T` — Giá trị dữ liệu cần lưu trữ.
+
+**Trả về:**
+`void`
+
+## Ví dụ
+
+<Source
+  language='typescript'
+  code={`
+import { sendClientStorage } from '@dxtmisha/figma'
+
+// 1. Lưu một chuỗi đơn giản
+sendClientStorage('user-theme', 'dark')
+
+// 2. Lưu một đối tượng (object)
+sendClientStorage('settings', { notifications: true, zoom: 100 })
+  `}
+/>

package/src/media/functional/figma/functions/sendFrameSelection/sendFrameSelection.en.mdx

@@ -0,0 +1,28 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/figma/Functions/sendFrameSelection - Request frame selection'/>
+
+# `sendFrameSelection`
+
+A utility for requesting the Figma plugin to select a specific frame in the document.
+
+**Parameters:**
+- `id?: string` — The ID of the frame to be selected. If not provided or empty, the selection might be cleared.
+
+**Returns:**
+`void`
+
+## Examples
+
+<Source
+  language='typescript'
+  code={`
+import { sendFrameSelection } from '@dxtmisha/figma'
+
+// Select a frame by its ID
+sendFrameSelection('12:34')
+
+// Clear or reset selection (depending on plugin implementation)
+sendFrameSelection()
+  `}
+/>

package/src/media/functional/figma/functions/sendFrameSelection/sendFrameSelection.ru.mdx

@@ -0,0 +1,28 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/figma/Functions/sendFrameSelection - Запрос выделения фрейма'/>
+
+# `sendFrameSelection`
+
+Утилита для отправки запроса в плагин Figma на выделение конкретного фрейма в документе.
+
+**Параметры:**
+- `id?: string` — Идентификатор (ID) фрейма, который необходимо выделить. Если не указан, выделение может быть сброшено.
+
+**Возвращает:**
+`void`
+
+## Примеры
+
+<Source
+  language='typescript'
+  code={`
+import { sendFrameSelection } from '@dxtmisha/figma'
+
+// Выделить фрейм по его ID
+sendFrameSelection('12:34')
+
+// Сбросить выделение
+sendFrameSelection()
+  `}
+/>

package/src/media/functional/figma/functions/sendFrameSelection/sendFrameSelection.vi.mdx

@@ -0,0 +1,28 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/figma/Functions/sendFrameSelection - Yêu cầu chọn frame'/>
+
+# `sendFrameSelection`
+
+Một tiện ích để yêu cầu plugin Figma chọn một frame cụ thể trong tài liệu.
+
+**Tham số:**
+- `id?: string` — ID của frame cần chọn. Nếu không được cung cấp, lựa chọn có thể bị xóa bỏ.
+
+**Trả về:**
+`void`
+
+## Ví dụ
+
+<Source
+  language='typescript'
+  code={`
+import { sendFrameSelection } from '@dxtmisha/figma'
+
+// Chọn một frame bằng ID của nó
+sendFrameSelection('12:34')
+
+// Xóa hoặc đặt lại lựa chọn
+sendFrameSelection()
+  `}
+/>

package/src/media/functional/figma/functions/sendFrameStyles/sendFrameStyles.en.mdx

@@ -0,0 +1,40 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/figma/Functions/sendFrameStyles - Send frame styles request'/>
+
+# `sendFrameStyles`
+
+A utility for sending a request to the Figma plugin to retrieve style information for specified frames.
+
+**Parameters:**
+- `attributes: UiFigmaFrameStylesMessengerAttributes` — The attributes for the request, including frame IDs and options.
+
+
+**Returns:**
+`void`
+
+## Examples
+
+<Source
+  language='typescript'
+  code={`
+import { sendFrameStyles } from '@dxtmisha/figma'
+
+// Request styles for a specific frame
+sendFrameStyles({
+  ids: '12:34'
+})
+
+// Request styles for multiple frames including children
+sendFrameStyles({
+  ids: ['12:34', '56:78'],
+  children: true
+})
+  `}
+/>
+
+## Types
+
+### UiFigmaFrameStylesMessengerAttributes
+- `ids: string | string[]` — Unique frame ID or array of IDs.
+- `children?: boolean` — (Optional) Whether to include styles of child elements.

package/src/media/functional/figma/functions/sendFrameStyles/sendFrameStyles.ru.mdx

@@ -0,0 +1,40 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/figma/Functions/sendFrameStyles - Запрос стилей фреймов'/>
+
+# `sendFrameStyles`
+
+Утилита для отправки запроса в плагин Figma на получение информации о стилях указанных фреймов.
+
+**Параметры:**
+- `attributes: UiFigmaFrameStylesMessengerAttributes` — Атрибуты запроса, включая ID фреймов и дополнительные параметры.
+
+
+**Возвращает:**
+`void`
+
+## Примеры
+
+<Source
+  language='typescript'
+  code={`
+import { sendFrameStyles } from '@dxtmisha/figma'
+
+// Запросить стили для конкретного фрейма
+sendFrameStyles({
+  ids: '12:34'
+})
+
+// Запросить стили для нескольких фреймов, включая дочерние элементы
+sendFrameStyles({
+  ids: ['12:34', '56:78'],
+  children: true
+})
+  `}
+/>
+
+## Типы
+
+### UiFigmaFrameStylesMessengerAttributes
+- `ids: string | string[]` — Уникальный ID фрейма или массив ID.
+- `children?: boolean` — (Опционально) Включать ли стили дочерних элементов.

package/src/media/functional/figma/functions/sendFrameStyles/sendFrameStyles.vi.mdx

@@ -0,0 +1,40 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/figma/Functions/sendFrameStyles - Gửi yêu cầu lấy style của frame'/>
+
+# `sendFrameStyles`
+
+Một tiện ích để gửi yêu cầu đến Figma plugin để lấy thông tin style của các frame được chỉ định.
+
+**Tham số:**
+- `attributes: UiFigmaFrameStylesMessengerAttributes` — Các thuộc tính cho yêu cầu, bao gồm ID của frame và các tùy chọn.
+
+
+**Trả về:**
+`void`
+
+## Ví dụ
+
+<Source
+  language='typescript'
+  code={`
+import { sendFrameStyles } from '@dxtmisha/figma'
+
+// Yêu cầu style cho một frame cụ thể
+sendFrameStyles({
+  ids: '12:34'
+})
+
+// Yêu cầu style cho nhiều frame bao gồm cả các phần tử con
+sendFrameStyles({
+  ids: ['12:34', '56:78'],
+  children: true
+})
+  `}
+/>
+
+## Các kiểu dữ liệu
+
+### UiFigmaFrameStylesMessengerAttributes
+- `ids: string | string[]` — ID duy nhất của frame hoặc mảng các ID.
+- `children?: boolean` — (Tùy chọn) Có bao gồm style của các phần tử con hay không.

package/src/media/functional/figma/functions/sendFramesSelected/sendFramesSelected.en.mdx

@@ -0,0 +1,29 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/figma/Functions/sendFramesSelected - Update frame selection state'/>
+
+# `sendFramesSelected`
+
+A utility for notifying the Figma plugin to update the selection state of a specific frame. This is typically used to add or remove frames from a multi-selection list managed by the plugin.
+
+**Parameters:**
+- `id: string` — The ID of the frame.
+- `selected: boolean` — The desired selection state (true to select, false to deselect).
+
+**Returns:**
+`void`
+
+## Examples
+
+<Source
+  language='typescript'
+  code={`
+import { sendFramesSelected } from '@dxtmisha/figma'
+
+// Add a frame to the selection
+sendFramesSelected('12:34', true)
+
+// Remove a frame from the selection
+sendFramesSelected('12:34', false)
+  `}
+/>

package/src/media/functional/figma/functions/sendFramesSelected/sendFramesSelected.ru.mdx

@@ -0,0 +1,29 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/figma/Functions/sendFramesSelected - Обновление состояния выбора фрейма'/>
+
+# `sendFramesSelected`
+
+Утилита для уведомления плагина Figma об изменении состояния выбора конкретного фрейма. Обычно используется для добавления или удаления фреймов из списка множественного выбора, управляемого плагином.
+
+**Параметры:**
+- `id: string` — Идентификатор (ID) фрейма.
+- `selected: boolean` — Желаемое состояние выбора (true — выбрать, false — отменить выбор).
+
+**Возвращает:**
+`void`
+
+## Примеры
+
+<Source
+  language='typescript'
+  code={`
+import { sendFramesSelected } from '@dxtmisha/figma'
+
+// Добавить фрейм в список выбранных
+sendFramesSelected('12:34', true)
+
+// Удалить фрейм из списка выбранных
+sendFramesSelected('12:34', false)
+  `}
+/>

package/src/media/functional/figma/functions/sendFramesSelected/sendFramesSelected.vi.mdx

@@ -0,0 +1,29 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/figma/Functions/sendFramesSelected - Cập nhật trạng thái chọn frame'/>
+
+# `sendFramesSelected`
+
+Một tiện ích để thông báo cho plugin Figma cập nhật trạng thái lựa chọn của một frame cụ thể. Điều này thường được sử dụng để thêm hoặc xóa các frame khỏi danh sách đa lựa chọn do plugin quản lý.
+
+**Tham số:**
+- `id: string` — ID của frame.
+- `selected: boolean` — Trạng thái lựa chọn mong muốn (true để chọn, false để bỏ chọn).
+
+**Trả về:**
+`void`
+
+## Ví dụ
+
+<Source
+  language='typescript'
+  code={`
+import { sendFramesSelected } from '@dxtmisha/figma'
+
+// Thêm một frame vào lựa chọn
+sendFramesSelected('12:34', true)
+
+// Loại bỏ một frame khỏi lựa chọn
+sendFramesSelected('12:34', false)
+  `}
+/>

package/src/media/functional/figma/functions/sendStorage/sendStorage.en.mdx

@@ -0,0 +1,30 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/figma/Functions/sendStorage - Save data to shared storage'/>
+
+# `sendStorage`
+
+A utility for saving data to Figma's shared storage. Unlike client storage, this data can be shared and associated with specific identifiers (e.g., node IDs).
+
+**Parameters:**
+- `name: string` — The name of the storage.
+- `value: T` — The data value to be stored.
+- `id?: string` — (Optional) An identifier to associate the data with a specific object (e.g., node ID).
+
+**Returns:**
+`void`
+
+## Examples
+
+<Source
+  language='typescript'
+  code={`
+import { sendStorage } from '@dxtmisha/figma'
+
+// 1. Storing global data
+sendStorage('app-config', { version: '1.0.0' })
+
+// 2. Storing data for a specific node
+sendStorage('node-custom-data', { label: 'Header' }, '12:34')
+  `}
+/>

package/src/media/functional/figma/functions/sendStorage/sendStorage.ru.mdx

@@ -0,0 +1,30 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/figma/Functions/sendStorage - Сохранение данных в общее хранилище'/>
+
+# `sendStorage`
+
+Утилита для сохранения данных в общее хранилище Figma. В отличие от клиентского хранилища, эти данные могут быть связаны с конкретными идентификаторами (например, ID узлов) и доступны другим пользователям.
+
+**Параметры:**
+- `name: string` — Имя хранилища.
+- `value: T` — Данные для сохранения.
+- `id?: string` — (Опционально) Идентификатор для привязки данных к конкретному объекту (например, ID ноды).
+
+**Возвращает:**
+`void`
+
+## Примеры
+
+<Source
+  language='typescript'
+  code={`
+import { sendStorage } from '@dxtmisha/figma'
+
+// 1. Сохранение глобальных данных
+sendStorage('app-config', { version: '1.0.0' })
+
+// 2. Сохранение данных для конкретного узла (node)
+sendStorage('node-custom-data', { label: 'Header' }, '12:34')
+  `}
+/>

package/src/media/functional/figma/functions/sendStorage/sendStorage.vi.mdx

@@ -0,0 +1,30 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/figma/Functions/sendStorage - Lưu dữ liệu vào bộ nhớ chung'/>
+
+# `sendStorage`
+
+Một tiện ích để lưu dữ liệu vào bộ nhớ chung của Figma. Khác với bộ nhớ client, dữ liệu này có thể được chia sẻ và liên kết với các định danh cụ thể (ví dụ: ID của node).
+
+**Tham số:**
+- `name: string` — Tên của bộ nhớ.
+- `value: T` — Giá trị dữ liệu cần lưu trữ.
+- `id?: string` — (Tùy chọn) Định danh để liên kết dữ liệu với một đối tượng cụ thể (ví dụ: ID của node).
+
+**Trả về:**
+`void`
+
+## Ví dụ
+
+<Source
+  language='typescript'
+  code={`
+import { sendStorage } from '@dxtmisha/figma'
+
+// 1. Lưu dữ liệu toàn cục
+sendStorage('app-config', { version: '1.0.0' })
+
+// 2. Lưu dữ liệu cho một node cụ thể
+sendStorage('node-custom-data', { label: 'Header' }, '12:34')
+  `}
+/>

package/src/media/functional/figma-code/classes/FigmaClientStorage/FigmaClientStorage.en.mdx

@@ -0,0 +1,64 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/en/figma-code/Classes/FigmaClientStorage - Working with client storage'/>
+
+# Class `FigmaClientStorage`
+
+A high-level wrapper for Figma's `clientStorage` API. It provides a convenient interface for persistent data storage on the user's machine, supporting caching, default values, and automatic data management.
+
+## Key Features
+
+- **Singleton Access** — Use `getInstance()` to ensure consistent access to the same storage key across different parts of the plugin.
+- **Default Values** — The `get()` method can accept a default value or an asynchronous function to initialize the storage if it's empty.
+- **Cache Support** — Integrates with `FigmaStorageData` to manage data freshness and minimize redundant API calls.
+
+## Initialization
+
+Access an instance using the static `getInstance()` method.
+
+```typescript
+import { FigmaClientStorage } from '@dxtmisha/figma-code'
+
+// Get instance for 'user-settings'
+const storage = FigmaClientStorage.getInstance<object>('user-settings')
+```
+
+## Methods
+
+### Data Access
+
+#### `get`
+
+Retrieves data from the storage. If the storage is empty and a default value is provided, it sets and returns that value.
+
+**Parameters:**
+- `defaultValue?: T | (() => T | Promise<T>)` — (Optional) A value or function to initialize storage if no data is found.
+
+**Returns:** `Promise<T | undefined>` — The stored value.
+
+```typescript
+const theme = await storage.get('light')
+```
+
+#### `set`
+
+Updates the data in the storage.
+
+**Parameters:**
+- `value?: T | (() => T | Promise<T>)` — The new value or a function that returns it.
+
+**Returns:** `Promise<T | undefined>` — The newly set value.
+
+```typescript
+await storage.set('dark')
+```
+
+#### `remove`
+
+Deletes the data associated with the storage key.
+
+**Returns:** `Promise<this>` — The current instance.
+
+```typescript
+await storage.remove()
+```

package/src/media/functional/figma-code/classes/FigmaClientStorage/FigmaClientStorage.ru.mdx

@@ -0,0 +1,64 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/ru/figma-code/Classes/FigmaClientStorage - Работа с клиентским хранилищем'/>
+
+# Класс `FigmaClientStorage`
+
+Высокоуровневая обертка над API `clientStorage` в Figma. Предоставляет удобный интерфейс для постоянного хранения данных на машине пользователя, поддерживая кэширование, значения по умолчанию и автоматическое управление данными.
+
+## Ключевые особенности
+
+- **Доступ через Синглтон** — Используйте `getInstance()`, чтобы гарантировать согласованный доступ к одному и тому же ключу хранилища из разных частей плагина.
+- **Значения по умолчанию** — Метод `get()` может принимать значение по умолчанию или асинхронную функцию для инициализации хранилища, если оно пустое.
+- **Поддержка кэша** — Интеграция с `FigmaStorageData` для управления актуальностью данных и минимизации избыточных вызовов API.
+
+## Инициализация
+
+Получите экземпляр класса, используя статический метод `getInstance()`.
+
+```typescript
+import { FigmaClientStorage } from '@dxtmisha/figma-code'
+
+// Получение экземпляра для 'user-settings'
+const storage = FigmaClientStorage.getInstance<object>('user-settings')
+```
+
+## Методы
+
+### Доступ к данным
+
+#### `get`
+
+Получает данные из хранилища. Если хранилище пустое и передано значение по умолчанию, оно будет записано и возвращено.
+
+**Параметры:**
+- `defaultValue?: T | (() => T | Promise<T>)` — (Опционально) Значение или функция для инициализации хранилища при отсутствии данных.
+
+**Возвращает:** `Promise<T | undefined>` — Сохраненное значение.
+
+```typescript
+const theme = await storage.get('light')
+```
+
+#### `set`
+
+Обновляет данные в хранилище.
+
+**Параметры:**
+- `value?: T | (() => T | Promise<T>)` — Новое значение или функция, возвращающая его.
+
+**Возвращает:** `Promise<T | undefined>` — Новое установленное значение.
+
+```typescript
+await storage.set('dark')
+```
+
+#### `remove`
+
+Удаляет данные, связанные с ключом хранилища.
+
+**Возвращает:** `Promise<this>` — Текущий экземпляр.
+
+```typescript
+await storage.remove()
+```

package/src/media/functional/figma-code/classes/FigmaClientStorage/FigmaClientStorage.vi.mdx

@@ -0,0 +1,64 @@
+import { Meta, Source } from '@storybook/addon-docs/blocks'
+
+<Meta title='@dxtmisha/vi/figma-code/Classes/FigmaClientStorage - Làm việc với bộ nhớ client'/>
+
+# Lớp `FigmaClientStorage`
+
+Một lớp bọc cấp cao cho API `clientStorage` của Figma. Nó cung cấp một giao diện thuận tiện để lưu trữ dữ liệu bền vững trên máy tính của người dùng, hỗ trợ lưu trữ tạm thời (caching), các giá trị mặc định và quản lý dữ liệu tự động.
+
+## Các tính năng chính
+
+- **Truy cập Singleton** — Sử dụng `getInstance()` để đảm bảo quyền truy cập nhất quán vào cùng một khóa bộ nhớ từ các phần khác nhau của plugin.
+- **Giá trị mặc định** — Phương thức `get()` có thể nhận một giá trị mặc định hoặc một hàm bất đồng bộ để khởi tạo bộ nhớ nếu nó đang trống.
+- **Hỗ trợ Cache** — Tích hợp với `FigmaStorageData` để quản lý độ tươi mới của dữ liệu và giảm thiểu các lệnh gọi API dư thừa.
+
+## Khởi tạo
+
+Truy cập một thực thể bằng cách sử dụng phương thức tĩnh `getInstance()`.
+
+```typescript
+import { FigmaClientStorage } from '@dxtmisha/figma-code'
+
+// Lấy thực thể cho 'user-settings'
+const storage = FigmaClientStorage.getInstance<object>('user-settings')
+```
+
+## Các phương thức
+
+### Truy cập dữ liệu
+
+#### `get`
+
+Truy xuất dữ liệu từ bộ nhớ. Nếu bộ nhớ trống và một giá trị mặc định được cung cấp, nó sẽ thiết lập và trả về giá trị đó.
+
+**Tham số:**
+- `defaultValue?: T | (() => T | Promise<T>)` — (Tùy chọn) Một giá trị hoặc hàm để khởi tạo bộ nhớ nếu không tìm thấy dữ liệu.
+
+**Trả về:** `Promise<T | undefined>` — Giá trị được lưu trữ.
+
+```typescript
+const theme = await storage.get('light')
+```
+
+#### `set`
+
+Cập nhật dữ liệu trong bộ nhớ.
+
+**Tham số:**
+- `value?: T | (() => T | Promise<T>)` — Giá trị mới hoặc một hàm trả về giá trị đó.
+
+**Trả về:** `Promise<T | undefined>` — Giá trị mới vừa được thiết lập.
+
+```typescript
+await storage.set('dark')
+```
+
+#### `remove`
+
+Xóa dữ liệu liên kết với khóa bộ nhớ.
+
+**Trả về:** `Promise<this>` — Thực thể hiện tại.
+
+```typescript
+await storage.remove()
+```