Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: clean up TSDoc #122

Merged
merged 1 commit into from
Nov 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -693,8 +693,6 @@ export class DataTableBodyComponent<TRow extends { treeStatus?: TreeStatus } = a
* heights of the rows before it (i.e. row0 and row1).
*
* @returns the CSS3 style to be applied
*
* @memberOf DataTableBodyComponent
*/
rowsStyles = computed(() => {
const rowsStyles: NgStyle['ngStyle'][] = [];
Expand Down Expand Up @@ -738,8 +736,6 @@ export class DataTableBodyComponent<TRow extends { treeStatus?: TreeStatus } = a
* see description for `rowsStyles` signal
*
* @returns the CSS3 style to be applied
*
* @memberOf DataTableBodyComponent
*/
bottomSummaryRowsStyles = computed(() => {
if (!this.scrollbarV || !this.rows || !this.rows.length || !this.rowsToRender()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,6 @@ export class DatatableComponent<TRow = any>
/**
* Property to which you can use for determining select all
* rows on current page or not.
*
* @memberOf DatatableComponent
*/
@Input({ transform: booleanAttribute }) selectAllRowsOnPage = false;

Expand Down Expand Up @@ -657,8 +655,6 @@ export class DatatableComponent<TRow = any>
/**
* Reference to the header component for manually
* invoking functions on the header.
*
* @memberOf DatatableComponent
*/
@ViewChild(DataTableHeaderComponent)
headerComponent: DataTableHeaderComponent;
Expand Down
60 changes: 0 additions & 60 deletions projects/ngx-datatable/src/lib/types/table-column.type.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,43 +15,31 @@ export type TableColumnProp = string | number;
export interface TableColumn<TRow = any> {
/**
* Internal unique id
*
* @memberOf TableColumn
*/
$$id?: string;

/**
* Internal for column width distributions
*
* @memberOf TableColumn
*/
$$oldWidth?: number;

/**
* Internal for setColumnDefaults
*
* @memberOf TableColumn
*/
$$valueGetter?: ValueGetter;

/**
* Determines if column is checkbox
*
* @memberOf TableColumn
*/
checkboxable?: boolean;

/**
* Determines if the column is frozen to the left
*
* @memberOf TableColumn
*/
frozenLeft?: boolean;

/**
* Determines if the column is frozen to the right
*
* @memberOf TableColumn
*/
frozenRight?: boolean;

Expand All @@ -60,64 +48,46 @@ export interface TableColumn<TRow = any> {
* API from http =//www.w3.org/TR/css3-flexbox/. Basically;
* take any available extra width and distribute it proportionally
* according to all columns' flexGrow values.
*
* @memberOf TableColumn
*/
flexGrow?: number;

/**
* Min width of the column
*
* @memberOf TableColumn
*/
minWidth?: number;

/**
* Max width of the column
*
* @memberOf TableColumn
*/
maxWidth?: number;

/**
* The default width of the column, in pixels
*
* @memberOf TableColumn
*/
width?: number;

/**
* Can the column be resized
*
* @memberOf TableColumn
*/
resizeable?: boolean;

/**
* Custom sort comparator
*
* @memberOf TableColumn
*/
comparator?: any;

/**
* Custom pipe transforms
*
* @memberOf TableColumn
*/
pipe?: PipeTransform;

/**
* Can the column be sorted
*
* @memberOf TableColumn
*/
sortable?: boolean;

/**
* Can the column be re-arranged by dragging
*
* @memberOf TableColumn
*/
draggable?: boolean;

Expand All @@ -132,15 +102,11 @@ export interface TableColumn<TRow = any> {

/**
* Whether the column can automatically resize to fill space in the table.
*
* @memberOf TableColumn
*/
canAutoResize?: boolean;

/**
* Column name or label
*
* @memberOf TableColumn
*/
name?: string;

Expand All @@ -150,44 +116,31 @@ export interface TableColumn<TRow = any> {
* `someField` or `some.field.nested`, 0 (numeric)
*
* If left blank, will use the name as camel case conversion
*
* @memberOf TableColumn
*/
prop?: TableColumnProp;

/**
* Cell template ref
*
* @memberOf TableColumn
*/
cellTemplate?: TemplateRef<CellContext<TRow>>;

/**
* Ghost Cell template ref
*
* @memberOf TableColumn
*/
ghostCellTemplate?: TemplateRef<any>;

/**
* Header template ref
*
* @memberOf TableColumn
*/
headerTemplate?: TemplateRef<HeaderCellContext>;

/**
* Tree toggle template ref
*
* @memberOf TableColumn
*/
treeToggleTemplate?: any;

/**
* CSS Classes for the cell
*
*
* @memberOf TableColumn
*/
cellClass?:
| string
Expand All @@ -201,44 +154,31 @@ export interface TableColumn<TRow = any> {

/**
* CSS classes for the header
*
*
* @memberOf TableColumn
*/
headerClass?: string | ((data: { column: TableColumn }) => string | Record<string, boolean>);

/**
* Header checkbox enabled
*
* @memberOf TableColumn
*/
headerCheckboxable?: boolean;

/**
* Is tree displayed on this column
*
* @memberOf TableColumn
*/
isTreeColumn?: boolean;

/**
* Width of the tree level indent
*
* @memberOf TableColumn
*/
treeLevelIndent?: number;

/**
* Summary function
*
* @memberOf TableColumn
*/
summaryFunc?: (cells: any[]) => any;

/**
* Summary cell template ref
*
* @memberOf TableColumn
*/
summaryTemplate?: TemplateRef<any>;
}
Expand Down