Skip to content

filterPlaceholder parameter of filterParams has no effect on Date filter #333

Description

@msz0ke

According to the docs, the filterPlaceholder parameter of filterParams can be assigned to Date filters. I have tried to provide them as various string formats, but it has no effect on the placeholder text, even when the browserDatePicker property is set to False.

I suspect this is not an issue with dash-ag-grid but with ag-grid itself: https://github.com/ag-grid/ag-grid/issues?q=label%3AAG-3735+is%3Aclosed. As the issue has been in their backlog for quite some time, I think it would be necessary to remove this parameter from the docs. If there is a way to override the locale (since the date format is locale dependent for the Date selector), could you please provide an example?

Related MRE:

import dash_ag_grid as dag
from dash import Dash, html, dcc
import pandas as pd

app = Dash(__name__)


df = pd.read_csv(
    "https://raw.githubusercontent.com/plotly/datasets/master/ag-grid/olympic-winners.csv"
)

# basic columns definition with column defaults
columnDefs = [
    {"field": "athlete", "filter": False},
    {"field": "country", "filter": False},
    {
        "headerName": "Date",
        "filter": "agDateColumnFilter",
        "valueGetter": {"function": "d3.timeParse('%d/%m/%Y')(params.data.date)"},
        "valueFormatter": {"function": "params.data.date"},
        "filterParams": {
            "browserDatePicker": True,
            "filterPlaceholder": 'yyyy-mm-dd',
        },
    },
]

defaultColDef = {
    "flex": 1,
    "minWidth": 150,
    "filter": True,
    "floatingFilter": True,
}

app.layout = html.Div(
    [
        dcc.Markdown("Date Filter Example"),
        dag.AgGrid(columnDefs=columnDefs, rowData=df.to_dict("records"), defaultColDef=defaultColDef),
    ],
    style={"margin": 20},
)

if __name__ == "__main__":
    app.run_server(debug=True)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions