ar-design 0.2.62 → 0.2.63

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/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;

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

@@ -1,11 +1,79 @@
 import { IChildren } from "../../../libs/types/IGlobalProps";
 interface IProps extends IChildren {
+    /**
+     * Popover başlığı.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover title="Onay Gerekiyor" />
+     * ```
+     */
     title?: string;
+    /**
+     * Popover içinde gösterilecek mesaj metni.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover message="İşlemi onaylıyor musunuz?" />
+     * ```
+     */
     message?: string;
+    /**
+     * Popover içeriği olarak gösterilecek özel React JSX elementi.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover content={<CustomContent />} />
+     * ```
+     */
     content?: React.JSX.Element;
+    /**
+     * Onay veya iptal durumunda tetiklenen geri çağırma fonksiyonu.
+     *
+     * @param confirm - Kullanıcı onay verdiyse true, iptal ettiyse false.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover onConfirm={(confirm) => console.log(confirm)} />
+     * ```
+     */
     onConfirm?: (confirm: boolean) => void;
+    /**
+     * Popover açıkken sayfa dışında bir yere tıklandığında açık kalsın mı?
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover windowBlur={true} />
+     * ```
+     */
     windowBlur?: boolean;
+    /**
+     * Popover genişliği tam genişlikte mi olacak?
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover fullWidth={true} />
+     * ```
+     */
     fullWidth?: boolean;
+    /**
+     * Buton yapılandırmaları.
+     *
+     * - `okButton`: Onay butonunda gösterilecek metin.
+     * - `cancelButton`: (Opsiyonel) İptal butonunda gösterilecek metin.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Popover config={{ buttons: { okButton: "...", cancelButton: "..." } }} />
+     * ```
+     */
     config?: {
         buttons: {
             okButton: string;

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

@@ -1,6 +1,36 @@
 interface IProps {
+    /**
+     * İlerleme çubuğunun mevcut değeri.
+     * Genellikle 0 ile 100 arasında bir sayı olmalıdır.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Progress value={75} />
+     * ```
+     */
     value: number;
+    /**
+     * İlerleme çubuğunun ters yönde dolmasını sağlar.
+     * Varsayılan olarak false'tur.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Progress value={50} reverse={true} />
+     * ```
+     */
     reverse?: boolean;
+    /**
+     * İlerleme değerinin görünür olup olmadığını belirler.
+     * Varsayılan olarak true olabilir.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Progress value={30} isVisibleValue={false} />
+     * ```
+     */
     isVisibleValue?: boolean;
 }
 export default IProps;

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

@@ -1,6 +1,31 @@
 import { IChildren } from "../../../libs/types/IGlobalProps";
 interface IProps extends IChildren {
+    /**
+     * Gösterilecek metin veya metinler.
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Tooltip text="..."><Component>...</Component></Tooltip>
+     * <Tooltip text={["...", "..."]}><Component>...</Component></Tooltip>
+     * ```
+     */
     text: string | string[];
+    /**
+     * Tooltip'in hangi yönde görüneceği.
+     *
+     * Geçerli değerler:
+     * - `top`: Üstte
+     * - `right`: Sağda
+     * - `left`: Solda
+     * - `bottom`: Altta
+     *
+     * Örneğin;
+     *
+     * ```jsx
+     * <Tooltip text="Bilgi" direction="right"><Component>...</Component></Tooltip>
+     * ```
+     */
     direction?: "top" | "right" | "left" | "bottom";
 }
 export default IProps;

package/dist/components/navigation/pagination/IProps.d.ts

@@ -4,6 +4,7 @@ interface IProps {
      * Eğer belirtilmezse, 1. sayfa varsayılan olarak kabul edilir.
      *
      * Örneğin;
+     *
      * ```tsx
      * <Pagination defaultCurrent={3} />
      * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ar-design",
-  "version": "0.2.62",
+  "version": "0.2.63",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",