ar-design 0.2.61 → 0.2.63

package/dist/components/data-display/card/IProps.d.ts

@@ -1,7 +1,24 @@
-import React from "react";
-import { IChildren, IGlobalProps } from "../../../libs/types/IGlobalProps";
-interface IProps extends IGlobalProps, IChildren {
+import { IChildren } from "../../../libs/types/IGlobalProps";
+interface IProps extends IChildren {
+    /**
+     * Kart başlığı.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Card title="Kullanıcı Bilgileri" />
+     * ```
+     */
     title?: string;
+    /**
+     * Kartın sağ üst köşesinde gösterilecek aksiyonlar (buton, menü vb.).
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Card actions={<button>Düzenle</button>} />
+     * ```
+     */
     actions?: React.JSX.Element;
 }
 export default IProps;

package/dist/components/data-display/chip/IProps.d.ts

@@ -1,5 +1,14 @@
-import { IGlobalProps } from "../../../libs/types/IGlobalProps";
-interface IProps extends IGlobalProps {
+import { IBorder, IIcon, IStatus, IVariant } from "../../../libs/types/IGlobalProps";
+interface IProps extends IVariant, IStatus, IBorder, IIcon {
+    /**
+     * Bileşende gösterilecek metin.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Chip text="..." />
+     * ```
+     */
     text: string;
 }
 export default IProps;

package/dist/components/data-display/dnd/IProps.d.ts

@@ -1,7 +1,39 @@
 import React from "react";
 interface IProps<T> {
+    /**
+     * Sürüklenebilir liste verisi.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <DnD data={[{ id: 1, ... }, { id: 2, ... }]} />
+     * ```
+     */
     data: T[];
+    /**
+     * Her bir öğenin nasıl render edileceğini tanımlar.
+     *
+     * - `item`: Mevcut öğe.
+     * - `index`: Öğenin listedeki sırası.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <DnD renderItem={(item) => <div>{item.label}</div>} />
+     * ```
+     */
     renderItem: (item: T, index: number) => React.JSX.Element;
+    /**
+     * Sıralama değiştiğinde tetiklenen olay.
+     *
+     * - `data`: Yeni sıralanmış öğeler.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <DnD onChange={(data) => console.log("Yeni sıra:", data)} />
+     * ```
+     */
     onChange: (data: T[]) => void;
 }
 export default IProps;

package/dist/components/data-display/grid-system/column/IProps.d.ts

@@ -1,6 +1,33 @@
 type Column = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
 interface IProps {
+    /**
+     * Kolon içinde gösterilecek içerik.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Column>
+     *   <p>İçerik</p>
+     * </Column>
+     * ```
+     */
     children: React.ReactNode;
+    /**
+     * Kolon genişliğini belirler.
+     *
+     * - Sayı olarak verilirse tüm cihazlarda aynı genişlik uygulanır.
+     * - Obje olarak verilirse, farklı ekran boyutlarına göre özel kolon genişlikleri tanımlanabilir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Column size={6}>...</Column>
+     * ```
+     * veya
+     * ```jsx
+     * <Column size={{ xl: 3, md: 6, xs: 12 }}>...</Column>
+     * ```
+     */
     size?: {
         xl?: Column;
         lg?: Column;
@@ -8,6 +35,19 @@ interface IProps {
         sm?: Column;
         xs?: Column;
     } | number;
+    /**
+     * İçeriğin yatay hizalamasını belirler.
+     *
+     * - `left`: İçerik sola hizalanır.
+     * - `center`: İçerik yatayda ortalanır.
+     * - `right`: İçerik sağa hizalanır.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Column align="center">...</Column>
+     * ```
+     */
     align?: "left" | "center" | "right";
 }
 export default IProps;

package/dist/components/data-display/grid-system/index.d.ts

@@ -4,7 +4,7 @@ declare const Grid: {
         children: import("react").ReactNode;
         direction?: "flex-start" | "center" | "flex-end";
     }>;
-    Row: import("react").FC<import("./row/Types").Props>;
+    Row: import("react").FC<import("./row/IProps").default>;
     Column: import("react").FC<import("./column/IProps").default>;
 };
 export default Grid;

package/dist/components/data-display/grid-system/row/IProps.d.ts

@@ -0,0 +1,4 @@
+import { IChildren } from "../../../../libs/types/IGlobalProps";
+interface IProps extends IChildren {
+}
+export default IProps;

package/dist/components/data-display/grid-system/row/Row.d.ts

@@ -1,4 +1,4 @@
 import React from "react";
-import { Props } from "./Types";
-declare const Row: React.FC<Props>;
+import IProps from "./IProps";
+declare const Row: React.FC<IProps>;
 export default Row;

package/dist/components/data-display/table/IProps.d.ts

@@ -4,52 +4,165 @@ import { IChildren } from "../../../libs/types/IGlobalProps";
 import { FilterOperator } from "../../../libs/infrastructure/shared/Enums";
 export type Operator = "Contains" | "DoesNotContains" | "Equals" | "DoesNotEquals" | "BeginsWith" | "EndsWith" | "Blank" | "NotBlank";
 export type FilterValue = {
+    /**
+     * Filtre değeri olabilir: string, number veya boolean.
+     */
     value: string | number | boolean;
+    /**
+     * Uygulanacak filtre operatörü.
+     */
     operator: FilterOperator;
 };
 export type SearchedParam = {
     [key: string]: FilterValue | FilterValue[];
 };
 export type Config = {
+    /**
+     * Verilerin sunucu tarafında mı işlendiğini belirtir.
+     */
     isServerSide?: boolean;
+    /**
+     * Tablo içinde arama özelliğinin aktif olup olmadığı.
+     */
     isSearchable?: boolean;
+    /**
+     * Kaydırma özelliği ve maksimum yüksekliği.
+     */
     scroll?: {
+        /**
+         * Maksimum tablo yüksekliği (piksel cinsinden).
+         */
         maxHeight: number;
     };
+    /**
+     * Alt satır (subrow) özellikleri.
+     */
     subrow?: {
+        /**
+         * Alt satırın otomatik açılıp açılmayacağı.
+         */
         openAutomatically?: boolean;
+        /**
+         * Alt satırı açmak için seçici (CSS selector) tanımı.
+         */
         selector?: string;
+        /**
+         * Alt satır açma butonunun gösterilip gösterilmeyeceği.
+         */
         button?: boolean;
     };
 };
 type ImportActionType = {
+    /**
+     * Import butonunun üzerine gelindiğinde gösterilecek açıklayıcı metin.
+     */
     tooltip: string;
+    /**
+     * Kabul edilen dosya türleri.
+     */
     allowedTypes?: AllowedTypes[];
+    /**
+     * Butonun önünde gösterilecek içerik.
+     */
     prefixItem?: React.ReactNode;
+    /**
+     * Butonun arkasında gösterilecek içerik.
+     */
     suffixItem?: React.ReactNode;
+    /**
+     * Dosya import işlemi tetiklendiğinde çağrılan fonksiyon.
+     *
+     * @param formData - Dosyaları içeren FormData nesnesi (undefined olabilir).
+     * @param files - Seçilen dosyalar dizisi.
+     */
     onClick: (formData: FormData | undefined, files: File[]) => void;
 };
 type CreateActionType = {
+    /**
+     * Create butonunun üzerine gelindiğinde gösterilecek açıklayıcı metin.
+     */
     tooltip: string;
+    /**
+     * Butona tıklanıldığında tetiklenen fonksiyon.
+     */
     onClick: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
 };
 interface IProps<T> extends IChildren {
+    /**
+     * Tablo başlığı.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Table title="..." />
+     * ```
+     */
     title?: string;
+    /**
+     * Tabloya ait açıklama veya alt metin.
+     */
     description?: string;
+    /**
+     * Tabloya verilecek veri dizisi.
+     */
     data: T[];
+    /**
+     * Tablo kolonlarının tanımı.
+     */
     columns: TableColumnType<T>[];
+    /**
+     * Tablo üzerindeki eylem butonları.
+     */
     actions?: {
+        /**
+         * Dosya import işlemi için buton ayarları.
+         */
         import?: ImportActionType;
+        /**
+         * Yeni kayıt oluşturma butonu ayarları.
+         */
         create?: CreateActionType;
     };
+    /**
+     * Seçili satırlar değiştiğinde çağrılan fonksiyon.
+     *
+     * @param selectionItems - Seçilen satırların dizisi.
+     */
     selections?: (selectionItems: T[]) => void;
+    /**
+     * Daha önce seçilmiş satırlar.
+     */
     previousSelections?: T[];
+    /**
+     * Arama parametreleri ve sorgu değiştiğinde çağrılan fonksiyon.
+     *
+     * @param params - Arama parametreleri veya null.
+     * @param query - Arama sorgu metni.
+     * @param operator - Kullanılan filtre operatörü.
+     */
     searchedParams?: (params: SearchedParam | null, query: string, operator: FilterOperator) => void;
+    /**
+     * Sayfalama ayarları.
+     */
     pagination?: {
+        /**
+         * Toplam kayıt sayısı.
+         */
         totalRecords: number;
+        /**
+         * Sayfa başına gösterilecek kayıt sayısı.
+         */
         perPage: number;
+        /**
+         * Sayfa değiştirildiğinde tetiklenen fonksiyon.
+         *
+         * @param currentPage - Yeni sayfa numarası.
+         */
         onChange?: (currentPage: number) => void;
     };
+    /**
+     * Tablo yapılandırma ayarları.
+     */
     config?: Config;
 }
 export default IProps;

package/dist/components/data-display/tabs/IProps.d.ts

@@ -1,15 +1,54 @@
 import { TabProps } from "../../../libs/types";
-/**
- * Stepper component props
- */
 interface IProps {
     /**
      * Tab'ları temsil eden dizi.
-     * Her bir `Tab için gerekli özellikler `TabProps` tipinde olmalıdır.
+     * Her bir eleman `TabProps` tipinde olmalıdır.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Component
+     *   tabs={[
+     *     { title: "Ana Sayfa", content: <HomePage />, config: { canBeClosed: false } },
+     *     { title: "Profil", content: <Profile />, config: { canBeClosed: true } },
+     *   ]}
+     * />
+     * ```
      */
     tabs: TabProps[];
+    /**
+     * Aktif olarak seçili olan tab'ın indeksi.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Tabs activeTab={0} />
+     * ```
+     */
     activeTab?: number;
+    /**
+     * Tab değiştirildiğinde çağrılan fonksiyon.
+     *
+     * @param currentTab - Yeni seçilen tab'ın indeksi.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Tabs onChange={(currentTab) => console.log(currentTab)} />
+     * ```
+     */
     onChange?: (currentTab: number) => void;
+    /**
+     * Tab kapatıldığında çağrılan fonksiyon.
+     *
+     * @param closeTab - Kapatılan tab'ın indeksi.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Tabs onClose={(closeTab) => console.log(closeTab)} />
+     * ```
+     */
     onClose?: (closeTab: number) => void;
 }
 export default IProps;

package/dist/components/data-display/typography/paragraph/IProps.d.ts

@@ -1,7 +1,31 @@
 import { ParagraphColors, Status } from "../../../../libs/types";
-import { IChildren, IGlobalProps, ISizes } from "../../../../libs/types/IGlobalProps";
-interface IProps extends Omit<IGlobalProps, "status">, IChildren, ISizes {
+import { IChildren, ISize, IUpperCase } from "../../../../libs/types/IGlobalProps";
+interface IProps extends IChildren, ISize, IUpperCase {
+    /**
+     * Paragraf metninin rengi.
+     *
+     * `ParagraphColors` veya `Status` tipi değer alabilir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Paragraph color="error" />
+     * ```
+     */
     color?: ParagraphColors | Status;
+    /**
+     * Metnin yatay hizalamasını belirler.
+     *
+     * - `left`: Metin sola hizalanır.
+     * - `center`: Metin ortalanır.
+     * - `right`: Metin sağa hizalanır.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Paragraph align="left" />
+     * ```
+     */
     align?: "left" | "center" | "right";
 }
 export default IProps;

package/dist/components/data-display/typography/title/IProps.d.ts

@@ -1,7 +1,53 @@
-import { IChildren, IGlobalProps } from "../../../../libs/types/IGlobalProps";
-interface IProps extends Omit<IGlobalProps, "size">, IChildren {
+import { IChildren, IUpperCase } from "../../../../libs/types/IGlobalProps";
+interface IProps extends IChildren, IUpperCase {
+    /**
+     * Başlığın HTML seviyesini belirler.
+     *
+     * - `h1` en büyük başlıktır, `h6` ise en küçük.
+     * - Semantik anlamda uygun başlık seviyeleri kullanılması önerilir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Title Level="h2" />
+     * ```
+     */
     Level: "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+    /**
+     * Başlık metninin yatay hizalamasını belirler.
+     *
+     * - `"left"`: Metin sola hizalanır.
+     * - `"center"`: Metin ortalanır.
+     * - `"right"`: Metin sağa hizalanır.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Title align="center" />
+     * ```
+     */
     align?: "left" | "center" | "right";
+    /**
+     * Başlık metninin boyutunu belirler.
+     *
+     * Aşağıdaki CSS'e karşılık gelen değerleri destekler:
+     * - `"xx-small"` → Çok çok küçük
+     * - `"x-small"` → Çok küçük
+     * - `"small"` → Küçük
+     * - `"medium"` → Orta (varsayılan)
+     * - `"large"` → Büyük
+     * - `"x-large"` → Çok büyük
+     * - `"xx-large"` → Çok çok büyük
+     * - `"xxx-large"` → En büyük
+     * - `"smaller"` → Ebeveyn öğeye göre daha küçük
+     * - `"larger"` → Ebeveyn öğeye göre daha büyük
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Title size="x-large" />
+     * ```
+     */
     size?: "xx-small" | "x-small" | "small" | "medium" | "large" | "x-large" | "xx-large" | "xxx-large" | "smaller" | "larger";
 }
 export default IProps;

package/dist/components/feedback/alert/IProps.d.ts

@@ -1,7 +1,32 @@
-import { IChildren, IGlobalProps } from "../../../libs/types/IGlobalProps";
+import { IBorder, IChildren, IStatus } from "../../../libs/types/IGlobalProps";
 type message = string | message[];
-interface IProps extends Omit<IGlobalProps, "variant" | "icon">, IChildren {
+interface IProps extends IChildren, IStatus, IBorder {
+    /**
+     * Uyarı mesajı içeriğidir.
+     *
+     * `string` veya özel `message` tipi olabilir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Alert message="İşlem başarıyla tamamlandı." />
+     * ```
+     */
     message?: message;
+    /**
+     * Mesaj içindeki vurgulanacak kelime veya ifadeleri belirtir.
+     *
+     * Bu kelimeler mesaj içinde bold veya farklı stillerle öne çıkarılabilir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Alert
+     *   message="Kritik hata oluştu: sunucuya ulaşılamıyor."
+     *   emphasize={["...", "..."]}
+     * />
+     * ```
+     */
     emphasize?: string[];
 }
 export default IProps;

package/dist/components/feedback/modal/IProps.d.ts

@@ -1,19 +1,43 @@
-import React from "react";
-import { IChildren, ISizes } from "../../../libs/types/IGlobalProps";
-interface IProps extends IChildren, ISizes {
+import { IChildren, ISize } from "../../../libs/types/IGlobalProps";
+interface IProps extends IChildren, ISize {
     /**
+     * Modal'ın açık olup olmadığını kontrol eden ve değiştiren değerler.
      *
+     * - `get`: Modal açık mı?
+     * - `set`: Aç/kapa işlemini yapan fonksiyon.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * const [isOpen, setIsOpen] = useState(false);
+     *
+     * <Modal open={{ get: isOpen, set: setIsOpen }} />
+     * ```
      */
     open: {
         get: boolean;
         set: React.Dispatch<React.SetStateAction<boolean>>;
     };
     /**
-     * ...
+     * Modal başlığı.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Modal title="Bilgilendirme" />
+     * ```
      */
     title?: string;
     /**
-     * ...
+     * Modal alt içerik alanı (footer).
+     *
+     * Genellikle buton veya açıklamalar içerir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Modal footer={<button onClick={onClose}>Kapat</button>} />
+     * ```
      */
     footer?: React.ReactNode;
 }

package/dist/components/feedback/notification/IProps.d.ts

@@ -1,9 +1,70 @@
-import { Direction } from "../../../libs/core/application/contexts/Notification";
+import { Direction, Status } from "../../../libs/core/application/contexts/Notification";
 interface IProps {
+    /**
+     * Bildirim başlığı.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Notification title="Başarılı" />
+     * ```
+     */
     title: string;
+    /**
+     * Bildirimin içeriğinde gösterilecek opsiyonel mesaj.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Notification message="İşlem başarıyla tamamlandı." />
+     * ```
+     */
     message?: string;
-    status: string | number;
+    /**
+     * Bildirimin durumu.
+     *
+     * `Status` tipinde olmalıdır.
+     *
+     * Kabul edilen değerler:
+     * - `success`: Başarılı durum bildirimi.
+     * - `warning`: Uyarı durumu bildirimi.
+     * - `information`: Bilgilendirme durumu.
+     * - `error`: Hata durumu bildirimi.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Notification status="success" />
+     * ```
+     */
+    status: Status | number;
+    /**
+     * Bildirimin ekranda hangi köşede görüneceği.
+     *
+     * `Direction` tipinden olmalıdır.
+     *
+     * Geçerli değerler:
+     * - `top-left`: Sol üst köşe
+     * - `top-right`: Sağ üst köşe
+     * - `bottom-left`: Sol alt köşe
+     * - `bottom-right`: Sağ alt köşe
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Notification direction="top-right" />
+     * ```
+     */
     direction: Direction;
+    /**
+     * Bildirimin tetiklenip tetiklenmediğini belirten boolean değer.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Notification trigger={true} />
+     * ```
+     */
     trigger: boolean;
 }
 export default IProps;