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

Add demo about default values #112

Merged
merged 1 commit into from
Jan 10, 2023
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
49 changes: 49 additions & 0 deletions docs/demos/default-value/demo/demo-a.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
```hbs template
<div class="h-full overflow-auto" {{this.table.modifiers.container}}>
<table>
<thead>
<tr>
{{#each this.table.columns as |column|}}
<th>
{{column.name}}
</th>
{{/each}}
</tr>
</thead>
<tbody>
{{#each this.table.rows as |row|}}
<tr>
{{#each this.table.columns as |column|}}
<td>
{{column.getValueForRow row}}
</td>
{{/each}}
</tr>
{{/each}}
</tbody>
</table>
</div>
```

```js component
import Component from '@glimmer/component';

import { headlessTable } from 'ember-headless-table';
import { DATA } from 'docs-app/sample-data';

import { hbs } from 'ember-cli-htmlbars';
import { setComponentTemplate } from '@ember/component';

export default class extends Component {
table = headlessTable(this, {
columns: () => [
{ name: 'Column A', key: 'missing', options: () => ({ defaultValue: '???' }) },
{ name: 'column B', key: 'B' },
{ name: 'column C', key: 'alsoMissing' },
{ name: 'column D', key: 'D' },
{ name: 'column E', key: 'E' },
],
data: () => DATA,
});
}
```
44 changes: 44 additions & 0 deletions docs/demos/default-value/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Default values

The default value can be changed in the column config.


## Using strict mode

In strict mode, specifying a default value can be done like this:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is strict mode?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

```js
import Component from '@glimmer/component';
import { headlessTable } from 'ember-headless-table';

export default class Demo extends Component {
table = headlessTable(this, {
columns: () => [
{
name: 'Background color',
key: 'bgColor'
options: () => {
return {
defaultValue: '???',
};
}
}
/* ... */
],
/* ... */
});

<template>
{{#each this.table.rows as |row|}}
<tr>
{{#each this.table.columns as |column|}}

<td>
{{column.getValueForRow row}}
</td>

{{/each}}
</tr>
{{/each}}
</template>
}
```
7 changes: 6 additions & 1 deletion ember-headless-table/src/-private/interfaces/column.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ type ColumnPluginOption<P = Plugin> = P extends BasePlugin
? [Constructor<P>, () => ColumnOptionsFor<SignatureFrom<P>>]
: [P | Constructor<P>, () => unknown];

export type CellOptions = Record<string, unknown>;
export type CellOptions = {
/**
* when no value is present for a given set of data for the given column config
*/
defaultValue?: string;
} & Record<string, unknown>;

export interface ColumnConfig<T = unknown> {
/**
Expand Down