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.

Sign up for GitHub

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

Jump to bottom

refactor(react-grid): replace render functions with components in TableColumnVisibility #530

Merged
merged 3 commits into from
Dec 8, 2017
Merged

refactor(react-grid): replace render functions with components in TableColumnVisibility #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f444570
Replace render function with component
gsobolev Nov 29, 2017
d890ab8
Update table-column-visibility.md
viterobk Dec 4, 2017
bd0189f
Merge branch 'master' into tablecolumnvisibility-components
kvet Dec 8, 2017
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
4 changes: 1 addition & 3 deletions packages/dx-react-grid-bootstrap3/src/plugins/table-column-visibility.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ import PropTypes from 'prop-types';
import { TableColumnVisibility as TableColumnVisibilityBase } from '@devexpress/dx-react-grid';
import { EmptyMessage } from '../templates/empty-message';

const emptyMessageTemplate = props => <EmptyMessage {...props} />;

const defaultMessages = {
noColumns: 'Nothing to show',
};
Expand All @@ -15,7 +13,7 @@ export class TableColumnVisibility extends React.PureComponent {

return (
<TableColumnVisibilityBase
emptyMessageTemplate={emptyMessageTemplate}
emptyMessageComponent={EmptyMessage}
messages={{ ...defaultMessages, ...messages }}
{...restProps}
/>
Expand Down
4 changes: 1 addition & 3 deletions packages/dx-react-grid-material-ui/src/plugins/table-column-visibility.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ import PropTypes from 'prop-types';
import { TableColumnVisibility as TableColumnVisibilityBase } from '@devexpress/dx-react-grid';
import { EmptyMessage } from '../templates/empty-message';

const emptyMessageTemplate = props => <EmptyMessage {...props} />;

const defaultMessages = {
noColumns: 'Nothing to show',
};
Expand All @@ -15,7 +13,7 @@ export class TableColumnVisibility extends React.PureComponent {

return (
<TableColumnVisibilityBase
emptyMessageTemplate={emptyMessageTemplate}
emptyMessageComponent={EmptyMessage}
messages={{ ...defaultMessages, ...messages }}
{...restProps}
/>
Expand Down
12 changes: 7 additions & 5 deletions packages/dx-react-grid/docs/reference/table-column-visibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,15 @@ A plugin that manages Grid columns' visibility.

Name | Type | Default | Description
-----|------|---------|------------
hiddenColumns | Array&lt;string&gt; | [] | Specifies the hidden columns' names.
emptyMessageTemplate | () => ReactElement | | A template that renders a message that is displayed when all columns are hidden.
hiddenColumns | Array&lt;string&gt; | [] | The hidden column names.
emptyMessageComponent | ElementType&lt;[EmptyMessageProps](#emptymessageprops)&gt; | | A component that renders a message that is displayed when all columns are hidden.
messages | object | | An object that specifies the [localization messages](#localization-messages).

### <a name="empty-message-args"></a>EmptyMessageArgs
## Interfaces

Describes properties passed to the empty message template when it is being rendered.
### EmptyMessageProps

Describes empty message component's properties.

Field | Type | Description
------|------|------------
Expand All @@ -30,7 +32,7 @@ An object with the following shape:

Field | Type | Default | Description
------|------|---------|------------
noColumns? | string | 'Nothing to show' | Specifies the text displayed when the plugin does not contain visible columns.
noColumns? | string | 'Nothing to show' | Specifies the text that is displayed when the plugin does not contain visible columns.

## Plugin Developer Reference

Expand Down
15 changes: 9 additions & 6 deletions packages/dx-react-grid/src/plugins/table-column-visibility.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import {
Template,
TemplateConnector,
TemplatePlaceholder,
TemplateRenderer,
} from '@devexpress/dx-react-core';
import { visibleTableColumns, getMessagesFormatter } from '@devexpress/dx-grid-core';

Expand All @@ -16,7 +15,11 @@ const pluginDependencies = [

export class TableColumnVisibility extends React.PureComponent {
render() {
const { hiddenColumns, emptyMessageTemplate, messages } = this.props;
const {
hiddenColumns,
emptyMessageComponent: EmptyMessage,
messages,
} = this.props;
const visibleTableColumnsComputed = ({ tableColumns }) =>
visibleTableColumns(tableColumns, hiddenColumns);

Expand All @@ -33,9 +36,9 @@ export class TableColumnVisibility extends React.PureComponent {
<TemplateConnector>
{({ tableColumns }) => (tableColumns.length
? <TemplatePlaceholder />
: <TemplateRenderer
template={emptyMessageTemplate}
params={{ getMessage, ...params }}
: <EmptyMessage
getMessage={getMessage}
{...params}
/>
)}
</TemplateConnector>
Expand All @@ -48,7 +51,7 @@ export class TableColumnVisibility extends React.PureComponent {

TableColumnVisibility.propTypes = {
hiddenColumns: PropTypes.arrayOf(PropTypes.string),
emptyMessageTemplate: PropTypes.func.isRequired,
emptyMessageComponent: PropTypes.func.isRequired,
messages: PropTypes.object,
};

Expand Down
16 changes: 8 additions & 8 deletions packages/dx-react-grid/src/plugins/table-column-visibility.test.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ const defaultDeps = {
plugins: ['Table'],
};

const DefaultEmptyMessage = () => null;

describe('TableColumnVisibility', () => {
let resetConsole;
beforeAll(() => {
Expand All @@ -49,7 +51,7 @@ describe('TableColumnVisibility', () => {
{pluginDepsToComponents(defaultDeps)}
<TableColumnVisibility
hiddenColumns={hiddenColumns}
emptyMessageTemplate={() => null}
emptyMessageComponent={DefaultEmptyMessage}
/>
</PluginHost>
));
Expand All @@ -65,7 +67,7 @@ describe('TableColumnVisibility', () => {
{pluginDepsToComponents(defaultDeps)}
<TableColumnVisibility
hiddenColumns={hiddenColumns}
emptyMessageTemplate={() => null}
emptyMessageComponent={DefaultEmptyMessage}
/>
</PluginHost>
));
Expand All @@ -75,25 +77,23 @@ describe('TableColumnVisibility', () => {
});

it('should force the empty message rendering if all columns are hidden', () => {
const emptyMessageTemplate = jest.fn(() => null);
visibleTableColumns.mockImplementation(() => []);

mount((
const tree = mount((
<PluginHost>
{pluginDepsToComponents(defaultDeps)}
<TableColumnVisibility
hiddenColumns={[]}
emptyMessageTemplate={emptyMessageTemplate}
emptyMessageComponent={DefaultEmptyMessage}
messages={{
noColumns: 'Nothing to show',
}}
/>
</PluginHost>
));
const { getMessage } = emptyMessageTemplate.mock.calls[0][0];
const getMessage = tree.find(DefaultEmptyMessage)
.prop('getMessage');

expect(emptyMessageTemplate)
.toHaveBeenCalledTimes(1);
expect(getMessage('noColumns'))
.toBe('Nothing to show');
});
Expand Down