Skip to content

✨ Custom filter placeholder text for data table #2261

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

Merged
merged 5 commits into from
Oct 13, 2022
Merged

✨ Custom filter placeholder text for data table #2261

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9ab9351
:sparkles: Custom filter placeholder text for data table
Oct 6, 2022
ccba7e1
:memo: Updated docs
Oct 6, 2022
393194a
:white_check_mark: Update test and fix linting
Oct 7, 2022
d36bfe3
:rotating_light: Fix linter error, add changelog entry
Oct 13, 2022
7de7bce
Merge branch 'dev' into custom_placeholder_text_in_datatable_filter
alexcjohnson Oct 13, 2022
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
Prev Previous commit
Next Next commit
✅ Update test and fix linting
  • Loading branch information
pipeline committed Oct 7, 2022
commit 393194abe2325f089d61b2d8ef76ba6baf6d8e11
4 changes: 2 additions & 2 deletions components/dash-table/src/dash-table/dash/DataTable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import * as R from 'ramda';
import React, { Component, Suspense } from 'react';
import React, {Component, Suspense} from 'react';
import PropTypes from 'prop-types';
import { asyncDecorator } from '@plotly/dash-component-plugins';
import {asyncDecorator} from '@plotly/dash-component-plugins';

import LazyLoader from 'dash-table/LazyLoader';

Expand Down
2 changes: 1 addition & 1 deletion components/dash-table/src/dash-table/dash/Sanitizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const D3_DEFAULT_LOCALE: INumberLocale = {
const DEFAULT_NULLY = '';
const DEFAULT_SPECIFIER = '';
const NULL_SELECTED_CELLS: SelectedCells = [];
const DEFAULT_FILTER_PLACEHOLDER_TEXT = 'filter data...'
const DEFAULT_FILTER_PLACEHOLDER_TEXT = 'filter data...';

const DEFAULT_FILTER_OPTIONS = {
case: FilterCase.Sensitive,
Expand Down
66 changes: 39 additions & 27 deletions components/dash-table/tests/selenium/test_filter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import dash

from dash.dash_table import DataTable
from pyparsing import col

import pytest

Expand Down Expand Up @@ -81,7 +82,7 @@ def test_filt001_basic(test, props, expect):


@pytest.mark.parametrize(
"filter_options,column_filter_options",
"filter_case_options,column_case_filter_options",
[
("sensitive", None),
("sensitive", None),
Expand All @@ -91,45 +92,47 @@ def test_filt001_basic(test, props, expect):
("insensitive", "sensitive"),
],
)
def test_filt002_sensitivity(test, filter_options, column_filter_options):
def test_filt002_sensitivity(test, filter_case_options, column_case_filter_options):
props = dict(
id="table",
data=[dict(a="abc", b="abc", c="abc"), dict(a="ABC", b="ABC", c="ABC")],
columns=[
dict(
id="a",
name="a",
filter_options=dict(case=column_filter_options)
if column_filter_options is not None
filter_options=dict(case=column_case_filter_options)
if column_case_filter_options is not None
else None,
type="any",
),
dict(
id="b",
name="b",
filter_options=dict(case=column_filter_options)
if column_filter_options is not None
filter_options=dict(case=column_case_filter_options)
if column_case_filter_options is not None
else None,
type="text",
),
dict(
id="c",
name="c",
filter_options=dict(case=column_filter_options)
if column_filter_options is not None
filter_options=dict(case=column_case_filter_options)
if column_case_filter_options is not None
else None,
type="numeric",
),
],
filter_action="native",
filter_options=dict(case=filter_options)
if filter_options is not None
filter_options=dict(case=filter_case_options)
if filter_case_options is not None
else None,
style_cell=dict(width=100, min_width=100, max_width=100),
)

sensitivity = (
filter_options if column_filter_options is None else column_filter_options
filter_case_options
if column_case_filter_options is None
else column_case_filter_options
)

test.start_server(get_app(props))
Expand Down Expand Up @@ -197,7 +200,7 @@ def test_filt002_sensitivity(test, filter_options, column_filter_options):


@pytest.mark.parametrize(
"filter_options,column_filter_options",
"filter_case_options,column_case_filter_options",
[
("sensitive", None),
("sensitive", None),
Expand All @@ -207,51 +210,58 @@ def test_filt002_sensitivity(test, filter_options, column_filter_options):
("insensitive", "sensitive"),
],
)
def test_filt003_sensitivity(test, filter_options, column_filter_options):
def test_filt003_sensitivity(test, filter_case_options, column_case_filter_options):
column_b_filter_option = dict(placeholder_text="some descriptive text")
if column_case_filter_options is not None:
column_b_filter_option["case"] = column_case_filter_options

props = dict(
id="table",
data=[dict(a="abc", b="abc", c="abc"), dict(a="ABC", b="ABC", c="ABC")],
columns=[
dict(
id="a",
name="a",
filter_options=dict(case=column_filter_options)
if column_filter_options is not None
filter_options=dict(case=column_case_filter_options)
if column_case_filter_options is not None
else None,
type="any",
),
dict(
id="b",
name="b",
filter_options=dict(case=column_filter_options)
if column_filter_options is not None
else None,
filter_options=column_b_filter_option,
type="text",
),
dict(
id="c",
name="c",
filter_options=dict(case=column_filter_options)
if column_filter_options is not None
filter_options=dict(case=column_case_filter_options)
if column_case_filter_options is not None
else None,
type="numeric",
),
],
filter_action="native",
filter_options=dict(case=filter_options)
if filter_options is not None
filter_options=dict(case=filter_case_options)
if filter_case_options is not None
else None,
style_cell=dict(width=100, min_width=100, max_width=100),
)

sensitivity = (
filter_options if column_filter_options is None else column_filter_options
filter_case_options
if column_case_filter_options is None
else column_case_filter_options
)

test.start_server(get_app(props))

target = test.table("table")

target.column("a").filter_placeholder() == "filter data..."
target.column("b").filter_placeholder() == "some descriptive text"

target.column("a").filter_value("contains A")
if sensitivity == "sensitive":
assert target.cell(0, "a").get_text() == "ABC"
Expand Down Expand Up @@ -313,20 +323,22 @@ def test_filt003_sensitivity(test, filter_options, column_filter_options):
(None, None, "filter data..."),
],
)
def test_filt003_placeholder(
def test_filt004_placeholder(
test, column_placeholder_setting, table_placeholder_setting, expected_placeholder
):
column_filter_setting = dict(case="sensitive")
if column_placeholder_setting is not None:
column_filter_setting["placeholder_text"] = column_placeholder_setting

props = dict(
id="table",
data=[],
columns=[
dict(
id="a",
name="a",
filter_options=dict(placeholder_text=column_placeholder_setting)
if column_placeholder_setting is not None
else None,
type="any",
filter_options=column_filter_setting,
),
],
filter_action="native",
Expand Down