مشاهده در GitHub

گزینه‌های Bootstrap Table

API گزینه‌های جدول Bootstrap Table.

در این صفحه

گزینه‌های جدول در jQuery.fn.bootstrapTable.defaults تعریف شده‌اند.

نکته: نام‌های گزینه‌های زیر (برای مثال، ajax، buttons، cache) دقیق نام‌های ویژگی‌هایی هستند که باید هنگام راه‌اندازی Bootstrap Table از طریق JavaScript استفاده شود.

برای مثال:

$('#table').bootstrapTable({
  ajax: yourFunction,
  cache: false,
  ...
})

-

  • ویژگی: data-toggle

  • نوع: String

  • جزئیات:

    فعال کردن جدول bootstrap بدون نوشتن JavaScript.

  • پیش‌فرض: 'table'

  • مثال: از HTML

ajax

  • ویژگی: data-ajax

  • نوع: Function

  • جزئیات:

    متدی برای جایگزینی فراخوانی ajax. باید همان API را که متد ajax jQuery پیاده‌سازی می‌کند، پیاده‌سازی کند.

  • پیش‌فرض: undefined

  • مثال: جدول AJAX

ajaxOptions

  • ویژگی: data-ajax-options

  • نوع: Object

  • جزئیات:

    گزینه‌های اضافی برای ارسال درخواست ajax. لیست مقادیر: jQuery.ajax.

  • پیش‌فرض: {}

  • مثال: گزینه‌های AJAX

buttons

  • ویژگی: data-buttons

  • نوع: Function

  • جزئیات:

    این گزینه امکان ایجاد/اضافه کردن دکمه‌های سفارشی به “نوار دکمه‌ها” (سمت راست بالا جدول) را می‌دهد. این دکمه‌ها را می‌توان با گزینه جدول buttonsOrder مرتب کرد، کلید/نام استفاده شده برای رویداد باید برای آن استفاده شود!

    دکمه سفارشی بسیار قابل پیکربندی است، گزینه‌های زیر موجود هستند:

    • text
      • توضیحات: این گزینه برای گزینه جدول showButtonText استفاده می‌شود.
      • نوع: String
    • icon
      • توضیحات: این گزینه برای گزینه جدول showButtonIcons استفاده می‌شود.
      • نوع: String - فقط نیاز به کلاس آیکون دارد، برای مثال fa-users
    • render
      • توضیحات: این گزینه را روی false تنظیم کنید تا دکمه به طور پیش‌فرض مخفی شود، دکمه وقتی که ویژگی داده data-show-button-name="true" را اضافه می‌کنید، دوباره قابل مشاهده می‌شود.
    • attributes
      • توضیحات: این گزینه امکان اضافه کردن ویژگی‌های html اضافی را می‌دهد، برای مثال title
      • نوع: Object
      • مثال: {title: 'Button title'}
    • html
      • توضیحات: اگر نمی‌خواهید html را خودکار تولید کنید، می‌توانید از این گزینه برای وارد کردن html سفارشی خود استفاده کنید. گزینه event فقط در صورت وجود name="button-name" در HTML سفارشی شما کار می‌کند. اگر این گزینه استفاده شود، گزینه‌های زیر نادیده گرفته می‌شوند:
        • text
        • icon
        • attributes
      • نوع: Function|String
    • event
      • توضیحات: باید در صورت تمایل به اضافه کردن یک رویداد به دکمه استفاده شود
      • نوع: Function|Object|String

    گزینه event را می‌توان به سه روش پیکربندی کرد. یک رویداد با رویداد click:

    {
      'event': () => { }
    }

    یک رویداد با نوع رویداد تعریف شده توسط خود:

      {
        'event': {
          'mouseenter': () => { }
        }
      }

    چندین رویداد با انواع رویداد تعریف شده توسط خود:

      {
        'event': {
          'click': () => { },
          'mouseenter': () => { },
          'mouseleave': () => { }
        }
      }

    نکته: به جای توابع درون‌خطی، می‌توانید نام‌های تابع نیز استفاده کنید.

    یک دکمه سفارشی پیکربندی شده ممکن است به این صورت باشد:

    {
      btnRemoveEvenRows: {
        'text': 'Remove even Rows',
        'icon': 'fa-trash',
        'event': () => {
          //DO STUFF TO REMOVE EVEN ROWS
        },
        'attributes': {
          'title': 'Remove all rows which has a even id'
        }
      }
    }
  • پیش‌فرض: {}

  • مثال: دکمه‌ها

buttonsAlign

  • ویژگی: data-buttons-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه دکمه‌های نوار ابزار را برابری کن. 'left'، 'right' قابل استفاده هستند.

  • پیش‌فرض: 'right'

  • مثال: برابری دکمه‌ها

buttonsAttributeTitle

  • ویژگی: data-buttons-attribute-title

  • نوع: String

  • جزئیات:

    شخصی‌سازی ویژگی titleدکمه‌های نوار ابزار، که عمدتاً برای شخصی‌سازی سبک نوار ابزار استفاده می‌شود.

  • پیش‌فرض: 'title'

  • مثال: عنوان ویژگی دکمه‌ها

buttonsClass

  • ویژگی: data-buttons-class

  • نوع: String

  • جزئیات:

    کلاس (اضافه شده بعد از 'btn-') دکمه‌های جدول را تعریف می‌کند.

  • پیش‌فرض: 'secondary'

  • مثال: کلاس دکمه‌ها

buttonsOrder

  • ویژگی: data-buttons-order

  • نوع: Array

  • جزئیات:

    نشان می‌دهد چگونه ترتیب سفارشی دکمه‌های نوار ابزار را برقرار کن.

  • پیش‌فرض: ['paginationSwitch', 'refresh', 'toggle', 'fullscreen', 'columns']

  • مثال: ترتیب دکمه‌ها

buttonsPrefix

  • ویژگی: data-buttons-prefix

  • نوع: String

  • جزئیات:

    پیشوند دکمه‌های جدول را تعریف می‌کند.

  • پیش‌فرض: 'btn'

  • مثال: پیشوند دکمه‌ها

buttonsToolbar

  • ویژگی: data-buttons-toolbar

  • نوع: String/Node

  • جزئیات:

    یک انتخابگر jQuery که نوار ابزار دکمه‌های سفارشی را نشان می‌دهد، برای مثال: #buttons-toolbar، .buttons-toolbar، یا یک گره DOM.

  • پیش‌فرض: undefined

  • مثال: نوار ابزار دکمه‌ها

cache

  • ویژگی: data-cache

  • نوع: Boolean

  • جزئیات:

    برای غیرفعال کردن کش کردن درخواست‌های AJAX، false را تنظیم کن.

  • پیش‌فرض: true

  • مثال: کش جدول

cardView

  • ویژگی: data-card-view

  • نوع: Boolean

  • جزئیات:

    برای نمایش جدول نمای کارت، برای مثال، نمای موبایل، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نمای کارت

checkboxHeader

  • ویژگی: data-checkbox-header

  • نوع: Boolean

  • جزئیات:

    برای مخفی کردنجعبه بررسی انتخاب همه در ردیف هدر، false را تنظیم کن.

  • پیش‌فرض: true

  • مثال: جعبه بررسی هدر

classes

  • ویژگی: data-classes

  • نوع: String

  • جزئیات:

    نام کلاس جدول. 'table'، 'table-bordered'، 'table-hover'، 'table-striped'، 'table-dark'، 'table-sm' و 'table-borderless' قابل استفاده هستند. به طور پیش‌فرض، جدول دارای حاشیه است.

  • پیش‌فرض: 'table table-bordered table-hover'

  • مثال: کلاس‌های جدول

clickToSelect

  • ویژگی: data-click-to-select

  • نوع: Boolean

  • جزئیات:

    برای انتخاب جعبه بررسی یا جعبه رادیویی در هنگام کلیک بر روی ردیف‌ها، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: کلیک برای انتخاب

columns

  • ویژگی: -

  • نوع: Array

  • جزئیات:

    شیء پیکربندی ستون‌های جدول. برای جزئیات بیشتر به ویژگی‌های ستون مراجعه کنید.

  • پیش‌فرض: []

  • مثال: ستون‌های جدول

contentType

  • ویژگی: data-content-type

  • نوع: String

  • جزئیات:

    contentType داده‌های راه دور درخواست، برای مثال: application/x-www-form-urlencoded.

  • پیش‌فرض: 'application/json'

  • مثال: نوع محتوا

customSearch

  • ویژگی: data-custom-search

  • نوع: Function

  • جزئیات:

    تابع جستجوی سفارشی به جای تابع جستجوی داخلی اجرا می‌شود، سه پارامتر می‌گیرد:

    • data: داده‌های جدول.
    • text: متن جستجو.
    • filter: شیء فیلتر از متد filterBy.

    مثال استفاده:

    function customSearch(data, text) {
      return data.filter(function (row) {
        return row.field.indexOf(text) > -1
      })
    }
  • پیش‌فرض: undefined

  • مثال: جستجوی سفارشی

customSort

  • ویژگی: data-custom-sort

  • نوع: Function

  • جزئیات:

    تابع مرتب سازی سفارشی به جای تابع مرتب سازی داخلی اجرا می‌شود، سه پارامتر می‌گیرد:

    • sortName: نام مرتب سازی.
    • sortOrder: ترتیب مرتب سازی.
    • data: داده‌های ردیف‌ها.
  • پیش‌فرض: undefined

  • مثال: مرتب سازی سفارشی

data

  • ویژگی: data-data

  • نوع: Array | Object

  • جزئیات:

    داده‌هایی که باید بارگذاری شود.

    اگر در داده‌ها خاصیت _<field>_rowspan یا _<field>_colspan وجود داشته باشد، سلول‌ها به صورت خودکار ادغام می‌شوند، برای مثال:

    $table.bootstrapTable({
      data: [
        {
          id: 1,
          name: 'Item 1',
          _name_rowspan: 2,
          price: '$1'
        },
        {
          id: 2,
          price: '$2'
        }
      ]
    })

    اگر از این ویژگی استفاده می‌کنید، data برای اطمینان از صحیح بودن فرمت الزامی است.

  • پیش‌فرض: []

  • مثال: از داده

dataField

  • ویژگی: data-data-field

  • نوع: String

  • جزئیات:

    کلید در JSON ورودی که حاوی لیست داده‌های 'rows' است.

  • پیش‌فرض: 'rows'

  • مثال: میدان کل/داده

dataType

  • ویژگی: data-data-type

  • نوع: String

  • جزئیات:

    نوع داده‌ای که انتظار دارید از سرور برگردد.

  • پیش‌فرض: 'json'

  • مثال: نوع داده

detailFilter

  • ویژگی: data-detail-filter

  • نوع: Function

  • جزئیات:

    وقتی detailView روی true تنظیم شود، انبساط هر ردیف را فعال کن. true برمی‌گرداند، و ردیف برای انبساط فعال خواهد شد، false برمی‌گرداند و انبساط برای ردیف غیرفعال خواهد شد. تابع پیش‌فرض true برمی‌گرداند تا انبساط برای همه ردیف‌ها مجاز شود.

  • پیش‌فرض: function(index, row) { return true }

  • مثال: فیلتر جزئیات

detailFormatter

  • ویژگی: data-detail-formatter

  • نوع: Function

  • جزئیات:

    وقتی detailView روی true تنظیم شود، نمای جزئیات خود را قالب‌بندی کن. یک رشته برمی‌گرداند، و آنจะ به سلول نمای جزئیات اضافه می‌شود، اختیاریاً عنصر را مستقیماً با استفاده از پارامتر سوم، که یک عنصر jQuery از سلول هدف است، رندر می‌کند.

  • پیش‌فرض: function(index, row, element) { return '' }

  • مثال: نمای جزئیات

detailView

  • ویژگی: data-detail-view

  • نوع: Boolean

  • جزئیات:

    برای نمایش یک جدول نمای جزئی، true را تنظیم کن. می‌توانید گزینه uniqueId را تنظیم کنید تا وضعیت نمای جزئی در هنگام تازه‌سازی جدول حفظ شود.

  • پیش‌فرض: false

  • مثال: نمای جزئی با UniqueId

detailViewAlign

  • ویژگی: data-detail-view-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه محتوای نمای جزئی را برابری کن. 'left'، 'right'، 'center' قابل استفاده هستند.

  • پیش‌فرض: 'left'

  • مثال: برابری نمای جزئی

detailViewByClick

  • ویژگی: data-detail-view-by-click

  • نوع: Boolean

  • جزئیات:

    برای تغییر نمای جزئی هنگام کلیک بر روی یک سلول، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: آیکون نمای جزئی

detailViewIcon

  • ویژگی: data-detail-view-icon

  • نوع: Boolean

  • جزئیات:

    برای نمایش ستون نمای جزئی (آیکون плюس/منهای)، true را تنظیم کن.

  • پیش‌فرض: true

  • مثال: آیکون نمای جزئی

escape

  • ویژگی: data-escape

  • نوع: Boolean

  • جزئیات:

    یک رشته را برای درج در HTML فرار می‌کند، کاراکترهای &، <، >، "، ` و ' را جایگزین می‌کند. برای غیرفعال کردن آن برای عناوین ستون، گزینه escapeTitle را بررسی کن.

  • پیش‌فرض: false

  • مثال: Table Escape

escapeTitle

  • ویژگی: data-escape-title

  • نوع: Boolean

  • جزئیات:

    تعیین می‌کند که آیا گزینه escape باید روی عناوین ستون اعمال شود.

  • پیش‌فرض: true

  • مثال: Table Escape title

filterOptions

  • ویژگی: data-filter-options

  • نوع: Boolean

  • جزئیات:

    گزینه‌های فیلتر پیش‌فرض الگوریتم را تعریف می‌کند، filterAlgorithm: 'and' به معنی این است که تمام فیلترهای داده شده باید مطابقت داشته باشند، filterAlgorithm: 'or' به معنی این است که یکی از فیلترهای داده شده باید مطابقت داشته باشد.

  • پیش‌فرض: { filterAlgorithm: 'and' }

  • مثال: گزینه‌های فیلتر

fixedScroll

  • ویژگی: data-fixed-scroll

  • نوع: Boolean

  • جزئیات:

    برای فعال کردن موقعیت نوار جابجایی ثابت جدول در هنگام بارگذاری داده، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نوار جابجایی ثابت

footerField

  • ویژگی: data-footer-field

  • نوع: String

  • جزئیات:

    کلید شیء فوتر را تعریف می‌کند (از آرایه داده یا JSON پاسخ سرور). شیء فوتر می‌تواند برای تنظیم/تعریف colspan فوتر و/یا مقدار فوتر استفاده شود. فقط زمانی فعال می‌شود که data-pagination true باشد و data-side-pagination server باشد.

      {
        "rows": [
          {
            "id": 0,
            "name": "Item 0",
            "price": "$0",
            "amount": 3
          }
        ],
        "footer": {
          "id": "footer id",
          "_id_colspan": 2,
          "name": "footer name"
        }
      }
  • پیش‌فرض: footerField

  • مثال: فیلد فوتر

footerStyle

  • ویژگی: data-footer-style

  • نوع: Function

  • جزئیات:

    تابع قالب‌بندی سبک فوتر، یک پارامتر می‌گیرد:

    • column: شیء ستون.

    از classes یا css پشتیبانی می‌کند. مثال استفاده:

    function footerStyle(column) {
      return {
        css: { 'font-weight': 'normal' },
        classes: 'my-class'
      }
    }
  • پیش‌فرض: undefined

  • مثال: سبک فوتر

headerStyle

  • ویژگی: data-header-style

  • نوع: Function

  • جزئیات:

    تابع قالب‌بندی سبک هدر، یک پارامتر می‌گیرد:

    • column: شیء ستون.

    از classes یا css پشتیبانی می‌کند. مثال استفاده:

    function headerStyle(column) {
      return {
        css: { 'font-weight': 'normal' },
        classes: 'my-class'
      }
    }
  • پیش‌فرض: undefined

  • مثال: سبک هدر

height

  • ویژگی: data-height

  • نوع: Number

  • جزئیات:

    ارتفاع جدول، هدر ثابت جدول را فعال می‌کند.

  • پیش‌فرض: undefined

  • مثال: ارتفاع جدول

icons

  • ویژگی: data-icons

  • نوع: Object

  • جزئیات:

    آیکون‌هایی را که در نوار ابزار، صفحه‌بندی، و نمای جزئیات استفاده می‌شوند تعریف می‌کند.

  • پیش‌فرض:

    {
      paginationSwitchDown: 'fa-caret-square-down',
      paginationSwitchUp: 'fa-caret-square-up',
      refresh: 'fa-sync',
      toggleOff: 'fa-toggle-off',
      toggleOn: 'fa-toggle-on',
      columns: 'fa-th-list',
      fullscreen: 'fa-arrows-alt',
      detailOpen: 'fa-plus',
      detailClose: 'fa-minus'
    }
  • مثال: آیکون‌های جدول

iconSize

  • ویژگی: data-icon-size

  • نوع: String

  • جزئیات:

    اندازه آیکون را تعریف می‌کند، undefined، 'lg'، 'sm' قابل استفاده هستند.

  • پیش‌فرض: undefined

  • مثال: اندازه آیکون

iconsPrefix

  • ویژگی: data-icons-prefix

  • نوع: String

  • جزئیات:

    نام مجموعه آیکون را تعریف می‌کند. به طور پیش‌فرض، این گزینه به طور خودکار توسط تم محاسبه می‌شود.

    {
      bootstrap3: 'glyphicon',
      bootstrap4: 'fa',
      bootstrap5: 'bi',
      'bootstrap-table': 'icon',
      bulma: 'fa',
      foundation: 'fa',
      materialize: 'material-icons',
      semantic: 'fa'
    }
  • پیش‌فرض: undefined

  • مثال: پیشوند آیکون‌ها

idField

  • ویژگی: data-id-field

  • نوع: String

  • جزئیات:

    نشان می‌دهد کدام فیلد به عنوان مقدار جعبه بررسی/رادیویی استفاده خواهد شد، این همتای selectItemName است.

  • پیش‌فرض: undefined

  • مثال: فیلد ID

ignoreClickToSelectOn

  • ویژگی: data-ignore-click-to-select-on

  • نوع: Function

  • جزئیات:

    عناصر نادیده‌گیر clickToSelect را تنظیم کن. یک پارامتر می‌گیرد:

    • element: عنصری که روی آن کلیک شد.

    اگر کلیک باید نادیده گرفته شود true برمی‌گرداند، اگر کلیک باید باعث انتخاب ردیف شود false برمی‌گرداند. این گزینه فقط در صورت true بودن clickToSelect مرتبط است.

  • پیش‌فرض: { return ['A', 'BUTTON'].includes(tagName) }

  • مثال: نادیده گرفتن کلیک برای انتخاب روی

loadingFontSize

  • ویژگی: data-loading-font-size

  • نوع: String

  • جزئیات:

    برای تعریف اندازه فونت متن لودینگ، مقدار پیش‌فرض 'auto' است، که بر اساس عرض جدول به طور خودکار محاسبه می‌شود، بین 12px و 32px.

  • پیش‌فرض: 'auto'

  • مثال: اندازه فونت لودینگ

loadingTemplate

  • ویژگی: data-loading-template

  • نوع: Function

  • جزئیات:

    برای سفارشی کردن نوع لودینگ توسط خودتان. شیء پارامترها شامل:

    • loadingMessage: محلی formatLoadingMessage.
  • پیش‌فرض:

    function (loadingMessage) {
      return '<span class="loading-wrap">' +
        '<span class="loading-text">' +
        loadingMessage +
        '</span>' +
        '<span class="animation-wrap"><span class="animation-dot"></span></span>' +
        '</span>'
    }
  • مثال: قالب لودینگ

locale

  • ویژگی: data-locale

  • نوع: String

  • جزئیات:

    لوکال مورد استفاده توسط جدول را تنظیم کن (به عنوان مثال، 'zh-CN'). قبل از استفاده از این گزینه، فایل لوکال مربوطه باید پیش‌بارگذاری شود.

    سیستم از یک مکانیزم fallback برای لوکال‌ها پشتیبانی می‌کند، که سعی می‌کند آنها را در مرتبه اولویت زیر بارگذاری کند:

    • اولویت اول: تلاش برای بارگذاری کل لوکال مشخص شده (به عنوان مثال، 'zh-CN')
    • اولویت دوم: تلاش برای تبدیل زیرخط‌ها _ به خط تیره - و بزرگ‌نویسی کد منطقه (به عنوان مثال، تبدیل 'zh_CN' به 'zh-CN')
    • اولویت سوم: تلاش برای استفاده از کد زبان کوتاه (به عنوان مثال، fallback از 'zh-CN' به 'zh')
    • مرحله نهایی: استفاده از آخرین فایل لوکال بارگذاری شده (اگر هیچ فایل لوکالی بارگذاری نشده باشد، از لوکال پیش‌فرض درونی استفاده کنید)

    توجه: تنظیم این گزینه به undefined یا یک رشته خالی به طور خودکار از آخرین لوکال بارگذاری شده استفاده می‌کند (اگر هیچ فایل لوکالی بارگذاری نشده باشد، به طور پیش‌فرض 'en-US' استفاده می‌شود).

  • پیش‌فرض: undefined

  • مثال: لوکال جدول

maintainMetaData

  • ویژگی: data-maintain-meta-data

  • نوع: Boolean

  • جزئیات:

    برای حفظ μεταدیتاهای زیر در تغییر صفحه و جستجو، true را تنظیم کن:

    • ردیف‌های انتخاب شده
    • ردیف‌های پنهان
  • پیش‌فرض: false

  • مثال: حفظ μεταدیتا

method

  • ویژگی: data-method

  • نوع: String

  • جزئیات:

    نوع متد برای درخواست داده‌های راه دور.

  • پیش‌فرض: 'get'

  • مثال: متد جدول

minimumCountColumns

  • ویژگی: data-minimum-count-columns

  • نوع: Number

  • جزئیات:

    حداقل تعداد ستون‌هایی که منوی کشویی ستون‌ها را به طور خودکار نمایش می‌دهد.

  • پیش‌فرض: 1

  • مثال: حداقل تعداد ستون‌ها

multipleSelectRow

  • ویژگی: data-multiple-select-row

  • نوع: Boolean

  • جزئیات:

    برای فعال کردن انتخاب چندین خط، روی true تنظیم کن.

    وقتی فعال شد، کاربران می‌توانند چندین خط را با استفاده از روش‌های زیر انتخاب کنند:

    • Ctrl+click: انتخاب یا عدم انتخاب خطوط منفرد (در حالی که سایر خطوط انتخاب شده باقی می‌مانند)
    • Shift+click: انتخاب تمام خطوط بین خط فعلی انتخاب شده و خط کلیک شده (انتخاب رنج)
    • کلیک معمولی: اگر کلید تغییر دهنده نگه داشته نشود، فقط ردیف کلیک شده را انتخاب می‌کند در حالی که سایرین را غیرانتخاب می‌کند
  • پیش‌فرض: false

  • مثال: انتخاب چندین ردیف

pageList

  • ویژگی: data-page-list

  • نوع: Array

  • جزئیات:

    هنگام تنظیم ویژگی صفحه‌بندی، اندازه صفحه را با انتخاب لیست اولیه‌سازی کنید. اگر گزینه 'all' یا 'unlimited' را شامل کنید، تمام رکوردهای جدول نمایش داده می‌شوند.

    نکته: اگر جدول ردیف‌های کمتری نسبت به گزینه(های) دارد، گزینه‌ها به طور خودکار پنهان می‌شوند. برای غیرفعال کردن این ویژگی، می‌توانید smartDisplay را روی false تنظیم کنید.

  • پیش‌فرض: [10, 25, 50, 100]

  • مثال: لیست صفحه

pageNumber

  • ویژگی: data-page-number

  • نوع: Number

  • جزئیات:

    هنگام تنظیم ویژگی صفحه‌بندی، شماره صفحه را اولیه‌سازی کنید.

  • پیش‌فرض: 1

  • مثال: شماره صفحه

pageSize

  • ویژگی: data-page-size

  • نوع: Number

  • جزئیات:

    هنگام تنظیم ویژگی صفحه‌بندی، اندازه صفحه را اولیه‌سازی کنید.

  • پیش‌فرض: 10

  • مثال: اندازه صفحه

pagination

  • ویژگی: data-pagination

  • نوع: Boolean

  • جزئیات:

    برای نمایش یک نوار ابزار صفحه‌بندی در پایین جدول، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: صفحه‌بندی جدول

paginationDetailHAlign

  • ویژگی: data-pagination-detail-h-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه جزئیات صفحه‌بندی را برابری کن. 'left'، 'right' قابل استفاده هستند.

  • پیش‌فرض: 'left'

  • مثال: برابری افقی صفحه‌بندی

paginationHAlign

  • ویژگی: data-pagination-h-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه کنترل صفحه‌بندی را در افقی برابری کن، 'left'، 'right' یا 'center' قابل استفاده هستند.

  • پیش‌فرض: 'right'

  • مثال: برابری افقی صفحه‌بندی

paginationLoadMore

  • ویژگی: data-pagination-load-more

  • نوع: Boolean

  • جزئیات:

    برای فعال کردن بارگذاری داده‌های بیشتر از طریق صفحه‌بندی، true را تنظیم کن. فقط در صفحه‌بندی سمت کلاینت استفاده می‌شود. به طور کلی، برای پیاده‌سازی قابلیت “بارگذاری بیشتر”، اغلب نیاز به ترکیب آن با یک responseHandler برای پردازش داده‌های بازگشتی است.

    ابتدا برای سناریوهای که تعداد کل صفحات در آن‌ها نامشخص است استفاده می‌شود. در چنین مواردی، نمایش تعداد کل دقیق یا محاسبه تعداد کل صفحات امکان‌پذیر نیست. در عوض، یک فرمت نمایشی مانند “100+” را می‌توان برای نشان دادن وجود آیتم‌های اضافی فراتر از تعداد نمایش داده شده استفاده کرد. وقتی کاربر به آخرین صفحه برود، داده‌های بیشتری بارگذاری می‌شوند، همراه با به‌روزرسانی اطلاعات صفحه‌بندی. این فرآیند تا پایان بارگذاری تمام داده‌ها ادامه می‌یابد.

  • پیش‌فرض: false

  • مثال: بارگذاری بیشتر صفحه‌بندی

paginationLoop

  • ویژگی: data-pagination-loop

  • نوع: Boolean

  • جزئیات:

    برای فعال کردن حالت حلقه پیوسته صفحه‌بندی، true را تنظیم کن.

  • پیش‌فرض: true

  • مثال: حلقه صفحه‌بندی

paginationNextText

  • ویژگی: data-pagination-next-text

  • نوع: String

  • جزئیات:

    نشان می‌دهد آیکون یا متن را که باید در جزئیات صفحه‌بندی، دکمه بعدی نمایش داده شود.

  • پیش‌فرض: '›'

  • مثال: متن صفحه‌بندی

paginationPagesBySide

  • ویژگی: data-pagination-pages-by-side

  • نوع: Number

  • جزئیات:

    تعداد صفحات در هر طرف (راست، چپ) صفحه فعلی.

  • پیش‌فرض: 1

  • مثال: شماره شاخص صفحه‌بندی

paginationParts

  • ویژگی: data-pagination-parts

  • نوع: Array

  • جزئیات:

    این گزینه‌ها تعریف می‌کنند که کدام قسمت‌های صفحه‌بندی باید قابل‌مشاهده باشند.

    • pageInfo نشان می‌دهد کدام مجموعه داده در صفحه فعلی نمایش داده خواهد شد (به عنوان مثال، Showing 1 to 10 of 54 rows).
    • pageInfoShort شبیه به pageInfo، فقط نمایش می‌دهد که جدول چند ردیف دارد (به عنوان مثال، Showing 54 rows).
    • pageSize منوی کشویی را نشان می‌دهد که تعریف می‌کند چند ردیف باید در صفحه نمایش داده شود.
    • pageList قسمت اصلی صفحه‌بندی را نشان می‌دهد (لیست صفحات).
  • پیش‌فرض: ['pageInfo', 'pageSize', 'pageList']

  • مثال: قسمت‌های صفحه‌بندی

paginationPreText

  • ویژگی: data-pagination-pre-text

  • نوع: String

  • جزئیات:

    نشان می‌دهد آیکون یا متن را که باید در جزئیات صفحه‌بندی، دکمه قبلی نمایش داده شود.

  • پیش‌فرض: '‹'

  • مثال: متن صفحه‌بندی

paginationSuccessivelySize

  • ویژگی: data-pagination-successively-size

  • نوع: Number

  • جزئیات:

    حداکثر تعداد صفحات متوالی در یک ردیف.

  • پیش‌فرض: 5

  • مثال: شماره شاخص صفحه‌بندی

paginationUseIntermediate

  • ویژگی: data-pagination-use-intermediate

  • نوع: Boolean

  • جزئیات:

    صفحات میانی را برای دسترسی سریع محاسبه و نمایش می‌دهد.

  • پیش‌فرض: false

  • مثال: شماره شاخص صفحه‌بندی

paginationVAlign

  • ویژگی: data-pagination-v-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه صفحه‌بندی را عمودی برابری کن. 'top'، 'bottom'، 'both' (قرار دادن صفحه‌بندی در بالا و پایین) قابل استفاده هستند.

  • پیش‌فرض: 'bottom'

  • مثال: برابری عمودی صفحه‌بندی

queryParams

  • ویژگی: data-query-params

  • نوع: Function

  • جزئیات:

    هنگام درخواست داده‌های راه دور، می‌توانید پارامترهای اضافی را با اصلاح queryParams ارسال کنید.

    اگر queryParamsType = 'limit' باشد، شیء params شامل: limit، offset، search، sort، order است.

    در غیر این صورت، شامل: pageSize، pageNumber، searchText، sortName، sortOrder است.

    برای توقف درخواست، false برمی‌گرداند.

  • پیش‌فرض: function(params) { return params }

  • مثال: پارامترهای کوئری

queryParamsType

  • ویژگی: data-query-params-type

  • نوع: String

  • جزئیات:

    برای ارسال پارامترهای کوئری با نوع RESTFul، 'limit' را تنظیم کن.

  • پیش‌فرض: 'limit'

  • مثال: نوع پارامترهای کوئری

regexSearch

  • ویژگی: data-regex-search

  • نوع: Boolean

  • جزئیات:

    برای فعال کردن جستجوی regex، true را تنظیم کن. اگر این گزینه فعال باشد، می‌توانید با regex جستجو کنید، به عنوان مثال، [47a]$ برای تمام آیتم‌هایی که با 4، 7 یا a پایان می‌بینند. regex را می‌توان با /[47a]$/gim یا بدون flags [47a]$ وارد کرد. پرچم‌های پیش‌فرض gim هستند.

  • پیش‌فرض: false

  • مثال: جستجوی regex

rememberOrder

  • ویژگی: data-remember-order

  • نوع: Boolean

  • جزئیات:

    برای به خاطر سپردن ترتیب برای هر ستون، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: یادآوری ترتیب

responseHandler

  • ویژگی: data-response-handler

  • نوع: Function

  • جزئیات:

    قبل از بارگذاری داده‌های راه دور، فرمت داده‌های پاسخ را مدیریت کن. شیء پارامترها شامل:

    • res: داده‌های پاسخ.
    • jqXHR: شیء jqXHR، که مجموعه‌ای فراتر از شیء XMLHTTPRequest است. برای اطلاعات بیشتر، به نوع jqXHR مراجعه کنید.
  • پیش‌فرض: function(res) { return res }

  • مثال: مدیریت پاسخ

rowAttributes

  • ویژگی: data-row-attributes

  • نوع: Function

  • جزئیات:

    تابع فرمت‌کننده ویژگی ردیف، دو پارامتر می‌گیرد:

    • row: داده رکورد ردیف.
    • index: شاخص ردیف.

    تمام ویژگی‌های سفارشی را پشتیبانی می‌کند.

  • پیش‌فرض: {}

  • مثال: ویژگی‌های ردیف

rowStyle

  • ویژگی: data-row-style

  • نوع: Function

  • جزئیات:

    تابع فرمت‌کننده استایل ردیف، دو پارامتر می‌گیرد:

    • row: داده رکورد ردیف.
    • index: شاخص ردیف.

    کلاس‌ها یا CSS را پشتیبانی می‌کند.

  • پیش‌فرض: {}

  • مثال: استایل ردیف

  • ویژگی: data-search

  • نوع: Boolean

  • جزئیات:

    ورودی جستجو را فعال می‌کند.

    سه راه برای جستجو وجود دارد:

    • مقدار شامل کوئری جستجو است (پیش‌فرض). مثال: Github شامل git است.
    • مقدار باید دقیقاً با کوئری جستجو یکسان باشد. مثال: Github (مقدار) و Github (کوئری جستجو).
    • مقایسات (<، >، <=، =<، >=، =>). مثال: 4 بزرگتر از 3 است.

    نکات:

    • اگر می‌خواهید از یک ورودی جستجو سفارشی استفاده کنید، از searchSelector استفاده کنید.
    • همچنین می‌توانید با استفاده از گزینه regexSearch از طریق regex جستجو کنید.
    • اگر می‌خواهید پارامترهای قابل جستجو را به صفحه‌بندی سمت سرور ارسال کنید، از گزینه searchable استفاده کنید.
  • پیش‌فرض: false

  • مثال: جستجوی جدول

searchable

searchAccentNeutralise

  • ویژگی: data-search-accent-neutralise

  • نوع: Boolean

  • جزئیات:

    اگر می‌خواهید از ویژگی خنثی‌سازی آکцент استفاده کنید، آن را به true تنظیم کن.

  • پیش‌فرض: false

  • مثال: خنثی‌سازی آکцент جستجو

searchAlign

  • ویژگی: data-search-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه ورودی جستجو را برابری کن. 'left'، 'right' قابل استفاده هستند.

  • پیش‌فرض: 'right'

  • مثال: برابری جستجو

searchHighlight

  • ویژگی: data-search-highlight

  • نوع: Boolean

  • جزئیات:

    برای برجسته کردن متن جستجو شده (با استفاده از برچسب HTML <mark>) آن را به true تنظیم کن. همچنین می‌توانید یک فرمت‌کننده برجسته‌سازی سفارشی تعریف کنید، به عنوان مثال، برای مقادیر با HTML یا استفاده از رنگ برجسته‌سازی سفارشی.

  • پیش‌فرض: 'false'

  • مثال: برجسته‌سازی جستجو

searchOnEnterKey

  • ویژگی: data-search-on-enter-key

  • نوع: Boolean

  • جزئیات:

    متد جستجو تا زمانی که کلید Enter فشار داده شود، اجرا نمی‌شود.

  • پیش‌فرض: false

  • مثال: جستجو با کلید Enter

searchSelector

  • ویژگی: data-search-selector

  • نوع: Boolean|String

  • جزئیات:

    اگر این گزینه تنظیم شده باشد (باید یک انتخابگر dom معتبر باشد، به عنوان مثال، #customSearch)، عنصر dom پیدا شده (یک عنصر input) به جای ورودی جستجو داخلی، به عنوان جستجوی جدول استفاده خواهد شد.

  • پیش‌فرض: false

  • مثال: انتخابگر جستجو

searchText

  • ویژگی: data-search-text

  • نوع: String

  • جزئیات:

    هنگام تنظیم ویژگی جستجو، متن جستجو را راه‌اندازی کن.

  • پیش‌فرض: ''

  • مثال: متن جستجو

searchTimeOut

  • ویژگی: data-search-time-out

  • نوع: Number

  • جزئیات:

    برای فعال‌سازی جستجو، مهلت زمانی تنظیم کن.

  • پیش‌فرض: 500

  • مثال: مهلت جستجو

selectItemName

  • ویژگی: data-select-item-name

  • نوع: String

  • جزئیات:

    نام ورودی رادیو یا چک‌باکس.

  • پیش‌فرض: 'btSelectItem'

  • مثال: فیلد شناسه

serverSort

  • ویژگی: data-server-sort

  • نوع: Boolean

  • جزئیات:

    برای مرتب سازی داده‌ها در سمت کلاینت، false را تنظیم کن، فقط زمانی کار می‌کند که sidePagination برابر با server باشد.

  • پیش‌فرض: true

  • مثال: مرتب سازی سرور

showButtonIcons

  • ویژگی: data-show-button-icons

  • نوع: Boolean

  • جزئیات:

    تمام دکمه‌ها آیکون روی خودشان نمایش خواهند داد.

  • پیش‌فرض: true

  • مثال: نمایش آیکون‌های دکمه

showButtonText

  • ویژگی: data-show-button-text

  • نوع: Boolean

  • جزئیات:

    تمام دکمه‌ها متن روی خودشان نمایش خواهند داد.

  • پیش‌فرض: false

  • مثال: نمایش متن دکمه

showColumns

  • ویژگی: data-show-columns

  • نوع: Boolean

  • جزئیات:

    برای نمایش لیست کشویی ستون‌ها، true را تنظیم کن. می‌توانیم گزینه ستون switchable را به false تنظیم کنیم تا آیتم ستون‌ها در لیست کشویی پنهان شود. حداقل تعداد ستون‌های انتخاب شده را می‌توان با گزینه جدول minimumCountColumns کنترل کرد.

  • پیش‌فرض: false

  • مثال: ستون‌های پایه و ستون‌های بزرگ

showColumnsSearch

  • ویژگی: data-show-columns-search

  • نوع: Boolean

  • جزئیات:

    برای نمایش جستجو برای فیلتر ستون‌ها، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: جستجوی ستون‌ها

showColumnsToggleAll

  • ویژگی: data-show-columns-toggle-all

  • نوع: Boolean

  • جزئیات:

    برای نمایش یک چک‌باکس بروکر تمام در داخل گزینه/لیست کشویی ستون‌ها، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: برقزنی تمام ستون‌ها

showExtendedPagination

  • ویژگی: data-show-extended-pagination

  • نوع: Boolean

  • جزئیات:

    برای نمایش نسخه‌ای گسترش‌یافته از صفحه‌بندی (از جمله تعداد تمام ردیف‌ها بدون فیلترها)، true را تنظیم کن. اگر صفحه‌بندی را در سمت سرور استفاده می‌کنید، لطفاً از totalNotFilteredField برای تعریف تعداد استفاده کنید.

  • پیش‌فرض: false

  • مثال: نمایش صفحه‌بندی گسترش‌یافته

showFooter

  • ویژگی: data-show-footer

  • نوع: Boolean

  • جزئیات:

    برای نمایش ردیف فوتر خلاصه، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نمایش فوتر

showFullscreen

  • ویژگی: data-show-fullscreen

  • نوع: Boolean

  • جزئیات:

    برای نمایش دکمه تمام‌صفحه، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نمایش تمام‌صفحه

showHeader

  • ویژگی: data-show-header

  • نوع: Boolean

  • جزئیات:

    برای پنهان کردن سربرگ جدول، false را تنظیم کن.

  • پیش‌فرض: true

  • مثال: نمایش سربرگ

showPaginationSwitch

  • ویژگی: data-show-pagination-switch

  • نوع: Boolean

  • جزئیات:

    برای نمایش دکمه سوئیچ صفحه‌بندی، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نمایش سوئیچ صفحه‌بندی

showRefresh

  • ویژگی: data-show-refresh

  • نوع: Boolean

  • جزئیات:

    برای نمایش دکمه تازه‌سازی، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نمایش تازه‌سازی

showSearchButton

  • ویژگی: data-show-search-button

  • نوع: Boolean

  • جزئیات:

    برای نمایش دکمه جستجو پشت ورودی جستجو، true را تنظیم کن. جستجو فقط در صورت فشار دادن دکمه اجرا خواهد شد (به عنوان مثال، برای جلوگیری از ترافیک یا زمان بارگذاری).

  • پیش‌فرض: false

  • مثال: نمایش دکمه جستجو

showSearchClearButton

  • ویژگی: data-show-search-clear-button

  • نوع: Boolean

  • جزئیات:

    برای نمایش دکمه پاکسازی پشت ورودی جستجو، true را تنظیم کن، که ورودی جستجو را پاک خواهد کرد (همچنین تمام فیلترها از کنترل فیلتر (اگر فعال باشد)).

  • پیش‌فرض: false

  • مثال: نمایش دکمه پاکسازی جستجو

showToggle

  • ویژگی: data-show-toggle

  • نوع: Boolean

  • جزئیات:

    برای نمایش دکمه تغییر برای تغییر بین نمای جدول/کارت، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: نمایش تغییر

sidePagination

  • ویژگی: data-side-pagination

  • نوع: String

  • جزئیات:

    سمت صفحه‌بندی جدول را تعریف می‌کند، فقط می‌تواند 'client' یا 'server' باشد. استفاده از سمت 'server' نیاز به تنظیم گزینه 'url' یا 'ajax' دارد.

    توجه داشته باشید که فرمت پاسخ سرور مورد نیاز بسته به اینکه گزینه 'sidePagination' روی 'client' یا 'server' تنظیم شده است، متفاوت است. مثال‌های زیر را ببینید:

    پارامترهای URL:

    هنگامی که sidePagination روی server تنظیم شده باشد، جدول bootstrap تماس‌هایی با url با پارامترهای URL زیر ایجاد خواهد کرد:

    • offset با مقدار بین 0 و total - 1، که اولین رکورد را که باید شامل شود، نشان می‌دهد.
    • limit با مقداری که تعداد ردیف‌های هر صفحه را نشان می‌دهد.

    هنگام پیاده‌سازی صفحه‌بندی سمت سرور، باید یک نمایش JSON را در یک فرمت مانند این مثال پیاده‌سازی کنید. آن نمایش باید مقادیر پارامتر URL بالا را دریافت کند و رکوردهایی را که از ایندکس offset شروع می‌شوند، برگرداند و تعداد رکوردهایی که توسط limit مشخص شده است، برگرداند. به عنوان مثال، اگر می‌خواهید رکوردهای 11-20 را دریافت کنید، نمایش شما باید offset=10 و limit=10 را از رشته URL دریافت کند و رکوردهایی مانند این مثال برگرداند.

  • پیش‌فرض: 'client'

  • مثال: صفحه‌بندی سمت کلاینت و صفحه‌بندی سمت سرور

silentSort

  • ویژگی: data-silent-sort

  • نوع: Boolean

  • جزئیات:

    برای مرتب سازی داده‌ها با پیام بارگذاری، false را تنظیم کن. این گزینه زمانی کار می‌کند که گزینه sidePagination روی 'server' تنظیم شده باشد.

  • پیش‌فرض: true

  • مثال: مرتب سازی ساکت

singleSelect

  • ویژگی: data-single-select

  • نوع: Boolean

  • جزئیات:

    برای அனுமத دادن به یک چک‌باکس برای انتخاب فقط یک ردیف، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: انتخاب تک‌گانه

smartDisplay

  • ویژگی: data-smart-display

  • نوع: Boolean

  • جزئیات:

    برای نمایش هوشمند صفحه‌بندی یا نمای کارت، true را تنظیم کن.

  • پیش‌فرض: true

  • مثال: نمایش هوشمند

sortable

  • ویژگی: data-sortable

  • نوع: Boolean

  • جزئیات:

    برای غیر فعال کردن قابلیت مرتب سازی تمام ستون‌ها، false را تنظیم کن.

  • پیش‌فرض: true

  • مثال: قابل مرتب سازی جدول

sortClass

  • ویژگی: data-sort-class

  • نوع: String

  • جزئیات:

    نام کلاس عناصر td که مرتب می‌شوند.

  • پیش‌فرض: undefined

  • مثال: کلاس مرتب سازی

sortEmptyLast

  • ویژگی: data-sort-empty-last

  • نوع: Boolean

  • جزئیات:

    برای مرتب سازی <empty string>، undefined و null به عنوان آخرین مقدار، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: مرتب سازی خالی در آخر

sortName

  • ویژگی: data-sort-name

  • نوع: String

  • جزئیات:

    تعریف می‌کند کدام ستون مرتب می‌شود. این فیلد ویژگی با sortOrder کار می‌کند، و هر دو باید به صورت مشترک برای عملکرد صحیح مرتب سازی استفاده شوند.

  • پیش‌فرض: undefined

  • مثال: نام و ترتیب مرتب سازی

sortOrder

  • ویژگی: data-sort-order

  • نوع: String

  • جزئیات:

    ترتیب مرتب سازی ستون را تعریف می‌کند، فقط می‌تواند undefined، 'asc' یا 'desc' باشد. این فیلد ویژگی با sortName کار می‌کند، و هر دو باید به صورت مشترک برای عملکرد صحیح مرتب سازی استفاده شوند.

  • پیش‌فرض: undefined

  • مثال: نام و ترتیب مرتب سازی

sortReset

  • ویژگی: data-sort-reset

  • نوع: Boolean

  • جزئیات:

    برای ریست کردن مرتب سازی در سومین کلیک، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: ریست مرتب سازی

sortResetPage

  • ویژگی: data-sort-reset-page

  • نوع: Boolean

  • جزئیات:

    برای ریست کردن شماره صفحه هنگام مرتب سازی، true را تنظیم کن.

  • پیش‌فرض: false

  • مثال: ریست صفحه مرتب سازی

sortStable

  • ویژگی: data-sort-stable

  • نوع: Boolean

  • جزئیات:

    برای دریافت مرتب سازی پایدار، true را تنظیم کن. ما ویژگی '_position' را به ردیف اضافه خواهیم کرد.

  • پیش‌فرض: false

  • مثال: مرتب سازی پایدار

strictSearch

  • ویژگی: data-strict-search

  • نوع: Boolean

  • جزئیات:

    جستجوی دقیق را فعال می‌کند. بررسی‌های مقایسه را غیر فعال می‌کند.

  • پیش‌فرض: false

  • مثال: جستجوی دقیق

theadClasses

  • ویژگی: data-thead-classes

  • نوع: String

  • جزئیات:

    نام کلاس thead جدول. Bootstrap از کلاس‌های تغییر دهنده .thead-light یا .thead-dark برای ایجاد ظاهر خاکستری روشن یا تیره برای thead استفاده می‌کند.

  • پیش‌فرض: ''

  • مثال: کلاس‌های thead

toolbar

  • ویژگی: data-toolbar

  • نوع: String/Node

  • جزئیات:

    یک انتخابگر jQuery که تولبار را نشان می‌دهد، به عنوان مثال: #toolbar، .toolbar، یا یک گره DOM.

  • پیش‌فرض: undefined

  • مثال: تولبار سفارشی

toolbarAlign

  • ویژگی: data-toolbar-align

  • نوع: String

  • جزئیات:

    نشان می‌دهد چگونه تولبار سفارشی را برابری کن. 'left'، 'right' قابل استفاده هستند.

  • پیش‌فرض: 'left'

  • مثال: برابری تولبار

totalField

  • ویژگی: data-total-field

  • نوع: String

  • جزئیات:

    کلید در JSON ورودی که حاوی داده‌های 'total' است.

  • پیش‌فرض: 'total'

  • مثال: فیلد کل/داده

totalNotFiltered

  • ویژگی: data-total-not-filtered

  • نوع: Number

  • جزئیات:

    این ویژگی عمدتاً توسط سرور صفحه‌بندی وارد می‌شود، که استفاده از آن آسان است.

  • پیش‌فرض: 0

totalNotFilteredField

  • ویژگی: data-total-not-filtered-field

  • نوع: string

  • جزئیات:

    فیلد از پاسخ JSON برای showExtendedPagination استفاده خواهد شد.

  • پیش‌فرض: totalNotFiltered

  • مثال: فیلد کل بدون فیلتر

totalRows

  • ویژگی: data-total-rows

  • نوع: Number

  • جزئیات:

    این ویژگی عمدتاً توسط سرور صفحه‌بندی وارد می‌شود، که استفاده از آن آسان است.

  • پیش‌فرض: 0

trimOnSearch

  • ویژگی: data-trim-on-search

  • نوع: Boolean

  • جزئیات:

    برای برش فاصله‌ها در فیلد جستجو، true را تنظیم کن.

  • پیش‌فرض: true

  • مثال: برش در جستجو

undefinedText

  • ویژگی: data-undefined-text

  • نوع: String

  • جزئیات:

    متن پیش‌فرض undefined را تعریف می‌کند.

  • پیش‌فرض: '-'

  • مثال: متن نامشخص

uniqueId

  • ویژگی: data-unique-id

  • نوع: String

  • جزئیات:

    شناسه منحصربفرد برای هر ردیف را نشان می‌دهد. شناسه منحصربفرد باید همیشه برای html امن باشد، به عنوان مثال، الفبایی-عددی، نباید شامل کاراکترهایی باشد که html را از هم می‌بزنند، به عنوان مثال، ".

  • پیش‌فرض: undefined

  • مثال: getRowByUniqueId

url

  • ویژگی: data-url

  • نوع: String

  • جزئیات:

    URL برای درخواست داده‌ها از سایت راه دور.

    توجه داشته باشید که فرمت پاسخ سرور مورد نیاز بسته به اینکه گزینه 'sidePagination' مشخص شده است یا خیر، متفاوت است. مثال‌های زیر را ببینید:

    پارامترهای URL:

    هنگامی که sidePagination روی server تنظیم شده باشد، جدول bootstrap تماس‌هایی با url با پارامترهای URL زیر ایجاد خواهد کرد:

    • offset با مقدار بین 0 و total - 1، که اولین رکورد را که باید شامل شود، نشان می‌دهد.
    • limit با مقداری که تعداد ردیف‌های هر صفحه را نشان می‌دهد.

    هنگام پیاده‌سازی صفحه‌بندی سمت سرور، باید یک نمایش JSON را در یک فرمت مانند این مثال پیاده‌سازی کنید. آن نمایش باید مقادیر پارامتر URL بالا را دریافت کند و رکوردهایی را که از ایندکس offset شروع می‌شوند، برگرداند و تعداد رکوردهایی که توسط limit مشخص شده است، برگرداند. به عنوان مثال، اگر می‌خواهید رکوردهای 11-20 را دریافت کنید، نمایش شما باید offset=10 و limit=10 را از رشته URL دریافت کند و رکوردهایی مانند این مثال برگرداند.

  • پیش‌فرض: undefined

  • مثال: از URL

  • مدیریت خطا

    برای دریافت خطاهای بارگذاری، لطفاً از onLoadError استفاده کنید

virtualScroll

  • ویژگی: data-virtual-scroll

  • نوع: Boolean

  • جزئیات:

    برای فعال کردن اسکرول مجازی برای نمایش یک لیست مجازی، “беakon”، true را تنظیم کن.

    توجه: در حال حاضر، پیاده‌سازی فرض می‌کند که هر خط ارتفاع یکسانی دارد. اگر ارتفاع خطوط متفاوت باشد، اشکالات غیرقابل‌پیش‌بینی ممکن است رخ دهد. لطفاً مطمئن شوید که ارتفاع هر خط ثابت است، یا برای برطرف کردن این مشکل استایل td { white-space: nowrap; } را اعمال کنید.

  • پیش‌فرض: false

  • مثال: داده‌های بزرگ

virtualScrollItemHeight

  • ویژگی: data-virtual-scroll-item-height

  • نوع: Number

  • جزئیات:

    اگر این گزینه تعریف نشده باشد، ما به طور پیش‌فرض از ارتفاع اولین آیتم استفاده خواهیم کرد.

    در صورت که ارتفاع آیتم مجازی به طور قابل‌توجهی بزرگتر از ارتفاع پیش‌فرض باشد، ارائه این گزینه مهم است. این بعد برای تعیین اینکه چرا تعداد سلول‌هایی که باید در صورت راه‌اندازی ایجاد شوند و برای محاسبه ارتفاع ناحیه قابل‌اسکرول استفاده می‌شود. این مقدار ارتفاع فقط می‌تواند از واحد px استفاده کند.

  • پیش‌فرض: undefined

visibleSearch

  • ویژگی: data-visible-search

  • نوع: Boolean

  • جزئیات:

    برای جستجو فقط در ستون/داده‌های قابل‌مشاهده، true را تنظیم کن. اگر داده‌ها شامل مقادیر دیگر باشند که نمایش داده نمی‌شوند، در حین جستجو نادیده گرفته خواهند شد.

  • پیش‌فرض: false

  • مثال: جستجوی قابل‌مشاهده