الاستيراد
import { NuiGrid, NuiGridCell, type NuiGridColumn } from '@needless-ui/angular/grid';NuiGrid
شبكة بيانات على جدول أصلي.
| الاسم | النوع | القيمة الافتراضية | الوصف |
|---|---|---|---|
rowsثنائي الاتجاه | readonly T[] | البيانات. التعديلات تستبدل الصفوف، لذا اربطها عبر [(rows)]. | |
columnsمُدخَل | NuiGridColumn<T>[] | الأعمدة، على هيئة كائنات NuiGridColumn. | |
rowIdمُدخَل | (row: T) => unknown | row.id ?? row | مفتاح الصف، للتحديد والتتبّع. |
labelمُدخَل | string | اسم الشبكة الذي تقرؤه التقنيات المساعدة. | |
selectionمُدخَل | 'none' | 'single' | 'multiple' | 'none' | ما إذا كان يمكن تحديد الصفوف، وكم صفًّا. |
selectedثنائي الاتجاه | unknown[] | [] | مفاتيح الصفوف المحددة. |
sortثنائي الاتجاه | NuiGridSort[] | [] | الفرز، على هيئة كائنات { column, direction }؛ وللأول الأولوية. |
filtersثنائي الاتجاه | Record<string, NuiGridFilter> | {} | تصفية لكل معرّف عمود: مُعامِل وقيمة. |
searchثنائي الاتجاه | string | '' | كلمات يجب أن تظهر كلها في الصف. |
pageSizeثنائي الاتجاه | number | 0 | عدد الصفوف في الصفحة، أو 0 لقائمة واحدة قابلة للتمرير. |
pageثنائي الاتجاه | number | 0 | الصفحة المعروضة، بدءًا من 0. |
pageSizesمُدخَل | number[] | [10, 25, 50, 100] | الخيارات المتاحة في شريط الصفحات. |
virtualمُدخَل | boolean | 'auto' | 'auto' | يرسم الصفوف الظاهرة فقط: دائمًا، أو أبدًا، أو مع auto بعد 100 صف دون صفحات. |
heightمُدخَل | string | طول CSS يحدّ الشبكة؛ ويجري التمرير داخلها. | |
columnStateثنائي الاتجاه | NuiGridColumnState[] | [] | عرض كل عمود وترتيبه وتثبيته وظهوره، لحفظها واستعادتها. |
modeمُدخَل | 'client' | 'server' | 'client' | يعرض server الصفوف كما تصل، ويترك لك الفرز والتصفية والتقسيم إلى صفحات. |
totalمُدخَل | number | عدد الصفوف على الخادم. | |
loadingمُدخَل | boolean | false | يعرض شريط تقدّم، وصفوفًا مؤقتة ما دامت لا توجد صفوف. |
localeمُدخَل | string | LOCALE_ID | يُنسّق الأرقام والتواريخ، ويقرأ الأرقام المكتوبة. |
labelsمُدخَل | Partial<NuiGridLabels> | كل نص تعرضه الشبكة أو تُعلنه، لترجمته. | |
cornersمُدخَل | NuiCorners | شكل زواياه: round أو squircle أو bevel أو scoop أو notch أو square. | |
radiusمُدخَل | NuiRadius | حجم زواياه: none أو small أو medium أو large أو full. | |
densityمُدخَل | NuiDensity | المساحة التي يشغلها: compact أو regular أو roomy. | |
rowActivateمُخرَج | T | يُطلق الصف الذي فُتح بمفتاح Enter أو بنقرة مزدوجة. | |
cellEditمُخرَج | NuiGridEdit<T> | يُطلق كل تعديل معتمد. | |
queryChangeمُخرَج | NuiGridQuery | يُطلق الفرز وعوامل التصفية والبحث والصفحة كلما تغيّرت. | |
exportCsvدالة | (options?) => string | الصفوف المصفّاة والمفروزة من الأعمدة الظاهرة، بصيغة CSV. | |
focusCellدالة | (row: number, col: number) => void | ينقل التركيز إلى خلية؛ والصف -1 هو صف الرؤوس. | |
clearFiltersدالة | () => void | يمسح كل عوامل التصفية والبحث. |
مُدخلات التخصيص التي تتركها دون ضبط تتبع أقرب سمة data-nui-*. راجع دليل التخصيص.
NuiGridColumn
عمود واحد. ولا يلزم منه إلا id وheader.
| الاسم | النوع | القيمة الافتراضية | الوصف |
|---|---|---|---|
idخاصية | string | فريد؛ وهو المفتاح في الفرز والتصفية وحالة الأعمدة. | |
headerخاصية | string | نص رأس العمود. | |
valueخاصية | keyof T | ((row: T) => V) | مفتاح في الصف، أو دالة تأخذ الصف. وقيمته الافتراضية row[id]. | |
typeخاصية | 'text' | 'number' | 'date' | 'boolean' | 'enum' | 'text' | يحدد المحاذاة والفرز والتصفية والمحرِّر. |
formatخاصية | Intl options | ((value, row) => string) | خيارات Intl للأرقام والتواريخ، أو دالة تُنشئ النص. | |
optionsخاصية | NuiOption<V>[] | خيارات عمود enum، على هيئة كائنات NuiOption. | |
width, minWidth, maxWidthخاصية | number | بالبكسل. | |
flexخاصية | number | يتقاسم المساحة المتبقية مع أعمدة flex الأخرى. | |
alignخاصية | 'start' | 'center' | 'end' | افتراضيًا حسب النوع: الأرقام والتواريخ عند النهاية. | |
pinned, hiddenخاصية | 'start' | 'end', boolean | تثبيت العمود وظهوره في البداية. | |
sortable, filterable, resizable, reorderable, hideableخاصية | boolean | true | يمكن إيقاف كلٍّ منها بالقيمة false. |
compareخاصية | (a: V, b: V) => number | فرز مخصص. | |
editable, validateخاصية | boolean | ((row) => boolean), (value, row) => string | null | ما إذا كان يمكن تحرير الخلايا، ورسالة حين تكون القيمة غير صالحة. | |
setخاصية | (row: T, value: V) => T | يُنشئ الصف المعدَّل. وافتراضيًا، نسخة بالقيمة الجديدة. |
NuiGridCell
يرسم خلايا عمود. ويحتوي السياق على الصف وقيمة الخلية ونصها.
| الاسم | النوع | القيمة الافتراضية | الوصف |
|---|---|---|---|
nuiGridCellمُدخَل | string | معرّف العمود. |
NuiGridHeader
يرسم رأس عمود.
| الاسم | النوع | القيمة الافتراضية | الوصف |
|---|---|---|---|
nuiGridHeaderمُدخَل | string | معرّف العمود. |
NuiGridEmpty
ما يظهر حين لا توجد صفوف. ويُخبرك السياق إن كانت التصفية قد أخفتها.