Dash v2.5.1

Fixed

• #2087 Fix bug #2086 in which using id as a key within a component's id breaks the new callback context's args_grouping function.
• #2084 In dash 2.5.0, a default viewport meta tag was added as recommended for mobile-optimized sites by mdn
  This feature can be disabled by providing an empty viewport meta tag. e.g. app = Dash(meta_tags=[{"name": "viewport"}])
• #2090, #2092. Fixed bug where the path to the pages_folder was incorrect on Windows.

Removed

• #2087 Removed the undocumented callback context args_grouping_values property which was incompatible with pattern-matching callbacks.

Dash v2.5.0

Added

• #1947 Added pages - a better way to build multi-page apps. For more information see the forum post.
• #1965 Add component as props.
• #2049 Added wait_for_class_to_equal and wait_for_contains_class methods to dash.testing

Changed

• #2050 Changed find_element and find_elements to accept an attribute argument that aligns with Selenium's By class, allowing you to search elements by other attributes. Default value is CSS_SELECTOR to maintain backwards compatibility with previous find_elements.

Fixed

• #2043 Fix bug
  #2003 in which
  dangerously_allow_html=True + mathjax=True works in some cases, and in some cases not.
• #2065 Fix bug #2064 rendering of dcc.Dropdown with a value but no options.
• #2047 Fix bug #1979 in which DASH_DEBUG as environment variable gets ignored.
• #2070 Fix bug #2066 nested types triggering maximum call stack error when building typescript components.

Dash v2.4.1

Fixed

• Fix #2045 import error when using pytest but dash[testing] is not installed.

Dash v2.4.0

Added

• #1952 Improved callback_context

  • Closes #1818 Closes #1054
  • adds dash.ctx, a more concise name for dash.callback_context
  • adds ctx.triggered_prop_ids, a dictionary of the component ids and props that triggered the callback.
  • adds ctx.triggered_id, the id of the component that triggered the callback.
  • adds ctx.args_grouping, a dict of the inputs used with flexible callback signatures.

• #2009 Add support for Promises within Client-side callbacks as requested in #1364.

• #1956 Add TypeScript components generation.

• #2034 Add link_target prop to dcc.Markdown component. Closes #1827

• #2035 Add type annotations to testing fixtures.

Fixed

• #2029 Restrict the number of props listed explicitly in generated component constructors - default is 250. This prevents exceeding the Python 3.6 limit of 255 arguments. The omitted props are still in the docstring and can still be provided the same as before, they just won't appear in the signature so autocompletion may be affected.

• #1968 Fix bug #1877, code which uses merge_duplicate_headers and style_header_conditional to highlight columns, it incorrectly highlights header cells.

• #2015 Fix bug #1854 in which the combination of row_selectable="single or multi" and filter_action="native" caused the JS error.

• #1976 Fix #1962 in which DatePickerSingle and DatePickerRange are extremely slow when provided a long list of disabled_days.

• #2035 Fix #2033 In-App error reporting does not render HTML.

• #1970 dcc.Dropdown Refactor fixes:

  • Fix bug #1868 value does not update when selected option removed from options.
  • Fix bug #1908 Selected options not showing when the value contains a comma.

Changed

• #1751 Rename app.run_server to app.run while preserving app.run_server for backwards compatibility.

• #1839 The callback decorator returns the original function, not the wrapped function, so that you can still call these functions directly, for example in tests. Note that in this case there will be no callback context so not all callbacks can be tested this way.

• #2016 Drop the 375px width from default percy_snapshot calls, keep only 1280px

• #2027 Improve the error message when a user doesn't wrap children in a list

Updated

• #2016, #2032, and #2042 Widespread dependency upgrades
  • Upgrade Plotly.js to v2.12.1 (from v2.11.0).
    • Feature release 2.12.0 adds minor ticks and gridlines, as well as dashed gridlines.
    • Patch release 2.11.1 fixes regl-based traces in strict CSP mode, however you must manually switch to the strict bundle to use this.
    • Patch release 2.12.1 fixes several bugs.
  • Upgrade black to v22.3.0 for Python 3.7+ - if you use dash[ci] and you call black, this may alter your code formatting slightly, including more consistently breaking Python 2 compatibility.
  • Many other mainly JS dependency upgrades to the internals of Dash renderer and components. These may patch bugs or improve performance.

Dash v2.3.1

Fixed

• #1963 Fix #1780 flask shutdown deprecation warning when running dashduo threaded tests.
• #1995 Fix #1992 ImportError: cannot import name 'get_current_traceback' from 'werkzeug.debug.tbtools'.

Dash v2.3.0

Added

• #1949 Add built-in MathJax support to both dcc.Markdown and dcc.Graph. A new boolean prop mathjax was added to these two components, defaulting to False. Set mathjax=True to enable math rendering. This work uses MathJax v3, although dcc.Graph and Plotly.js can also be used with MathJax v2.
  • In dcc.Markdown this has two flavors: inline math is any content between single dollar signs, for example "$E=mc^2$", and "display" math (on its own line, potentially multi-line) is delimited by double dollar signs.
  • In dcc.Graph, most text fields (graph and axis titles, trace names, scatter and bar text) can use math, and it's enabled with single dollar sign delimiters. A limitation here is that currently a given piece of text can only be one or the other: if math is found, everything outside the delimiters is ignored. See https://plotly.com/python/LaTeX/ for details.
  • For an intro to LaTeX math, see https://en.wikibooks.org/wiki/LaTeX/Mathematics.
  • Big thanks to Equinor for sponsoring this development, including the related work in Plotly.js!

Updated

• #1949 Upgrade Plotly.js to v2.11.0 (from v2.9.0)
  • Feature release 2.10.0:
    • Support for MathJax v3
    • fillpattern for scatter traces with filled area
  • Feature release 2.11.0:
    • Every trace type can now be rendered in a stricter CSP environment, specifically avoiding unsafe-eval. Please note: the regl-based traces (scattergl, scatterpolargl, parcoords, and splom) are only strict in the strict bundle, which is NOT served by default in Dash. To use this bundle with Dash, you must either download it and put it in your assets/ folder, or include it as an external_script from the CDN: https://cdn.plot.ly/plotly-strict-2.11.0.min.js. All other trace types are strict in the normal bundle.
  • Patch release 2.10.1 containing a bugfix for mesh3d traces.

Fixed

• #1915 Fix bug #1474 when both dcc.Graph and go.Figure have animation, and when the second animation in Figure is executed, the Frames from the first animation are played instead of the second one.

• #1953 Fix bug #1783 in which a failed hot reloader blocks the UI with alerts.

• #1942 Fix bug #1663 preventing pie traces from sending customdata with clickData and other events.

Dash v2.2.0

Added

• #1923:
  • dash.get_relative_path
  • dash.strip_relative_path
  • dash.get_asset_url
    This is similar to dash.callback where you don't need the app object. It makes it possible to use these
    functions in the pages folder of a multi-page app without running into the circular app imports issue.

Updated

• #1911 Upgrade Plotly.js to v2.9.0 (from v2.8.3).

  • Adds ticklabelstep to axes to reduce tick labels while still showing all ticks.
  • Displays the plotly.js version when hovering on the modebar. This helps debugging situations where there might be multiple sources of plotly.js, for example /assets vs the versions built into dcc or ddk.

• #1930 Upgrade JavaScript dependencies across renderer and all components.

Fixed

• #1932 Fixes several bugs:
  • Restores compatibility with IE11 #1925
  • Restores style_header text alignment in Dash Table #1914
  • Clears the unneeded webdriver-manager requirement from dash[testing] #1919

Dash v2.1.0

Changed

• #1876 Delays finalizing Dash.config attributes not used in the constructor until init_app().

• #1869, #1873 Upgrade Plotly.js to v2.8.3. This includes:

  • Feature release 2.5.0:
    • 3D traces are now compatible with no-unsafe-eval CSP rules.
  • Feature release 2.6.0:
    • Add smith subplots and scattersmith traces, for drawing Smith charts.
  • Feature release 2.7.0:
    • Add text data for histogram traces.
    • Fix an interaction between uirevision and autorange that pops up in some cases of mixed clientside / serverside figure generation.
  • Feature release 2.8.0:
    • Add horizontal colorbars.
    • Add text data on heatmap and related trace types.
    • Control legend group title fonts.
  • Patch releases 2.5.1, 2.6.1, 2.6.2, 2.6.3, 2.6.4, 2.8.1, 2.8.2, and 2.8.3 containing bugfixes.
  • This PR also upgrades various other dependencies of dash renderer and component suites.

• #1745:
  Improve our extras_require: there are now five options here, each with a well-defined role:

  • dash[dev]: for developing and building dash components.
  • dash[testing]: for using the pytest plugins in the dash.testing module
  • dash[diskcache]: required if you use DiskcacheLongCallbackManager
  • dash[celery]: required if you use CeleryLongCallbackManager
  • dash[ci]: mainly for internal use, these are additional requirements for the Dash CI tests, exposed for other component libraries to use a matching configuration.

Added

• #1883 in DataTable added page_current to persisted_props as requested in #1860

• #1763:

  Dash and Dash Renderer

  • Input, State, and Output now accept components instead of ID strings and Dash callback will auto-generate the component's ID under-the-hood if not supplied. This allows usage like:

  my_input = dcc.Input()
  my_output = html.Div()
  app.layout = html.Div([my_input, my_output])
  
  @dash.callback(Output(my_output, 'children'), Input(my_input, 'value'))
  def update(value):
      return f'You have entered {value}'

  Or, if using Python >=3.8 you can use the := walrus operator:

  app.layout = html.Div([
      my_input := dcc.Input(),
      my_output := html.Div()
  ])
  
  @dash.callback(Output(my_output, 'children'), Input(my_input, 'value'))
  def update(value):
      return f'You have entered {value}'

  #1894 restricted this feature so auto-generated IDs are not allowed if the app uses dash_snapshots (a Dash Enterprise package) or if the component uses persistence, as this can create confusing errors. Callback definitions can still reference components in these cases, but those components must have explicit IDs.

  Dash Core Components

  Rearranged Keyword Arguments & Flexible Types

  Dropdown, RadioItem, and Checklist

  • Rearranged Keyword Arguments - options & value are now the first two keywords which means they can be supplied as positional arguments without the keyword. Supplying the keywords (options= and value=) is still supported.
  • Flexible Types - options can be supplied in two new forms:
    1. An array of string|number|bool where label and value are equal to the items in the list.
    2. A dictionary where the keys and values set as value and label respectively.

  Before:

  dcc.Dropdown(
      options=[
          {'label': 'New York', 'value': 'New York'},
          {'label': 'Montreal', 'value': 'Montreal'},
      ],
      value='New York'
  )

  or

  dcc.Dropdown(
      options=[
          {'label': 'New York', 'value': 'NYC'},
          {'label': 'Montreal', 'value': 'MTL'},
      ],
      value='New York'
  )

  After:

  dcc.Dropdown(['New York', 'Montreal'], 'New York')

  Or

  dcc.Dropdown({'NYC': 'New York', 'MTL': 'Montreal'}, 'New York')

  RangeSlider & Slider

  • Rearranged Keyword Arugments - min, max, and step are now the first three keyword arguments which means they can be supplied as positional arguments without the keyword.
  • Flexible Types
    • step will be calculated implicitly if not given.
    • marks will be auto generated if not given. It will use min and max and will respect step if supplied. Auto generated marks labels are SI unit formatted. Around 5 human-readable marks will be created.
    • To remove the Slider's marks, set marks=None.

  Before:

  dcc.Slider(marks={1: 2, 2: 2, 3: 3})

  After:

  dcc.Slider(min=1, max=3, step=1)

  Or equivalently:

  dcc.Slider(1, 3, 1)

  Step can also be omitted and the Slider will attempt to create a nice, human readable step with SI units and around 5 marks:

  dcc.Slider(0, 100)

  The SI units and ranges supported in marks are:

  • µ - micro, 10⁻⁶
  • m - milli, 10⁻³
  • ​ (none) - 10⁰
  • k - kilo, 10³
  • M - mega, 10⁶
  • G - giga, 10⁹
  • T - tera, 10¹²
  • P - peta, 10¹⁵
  • E - exa, 10¹⁸

  Ranges below 10µ are not supported by the Slider. This is a bug: #1766

  DataTable

  • Rearranged Keyword Arguments - data and columns the first twokeyword arguments which means they can be supplied as positional arguments without the keyword.
  • Inferred Properties - If columns isn't supplied then it is extracted from the the first row in data

  Before:

  dash_table.DataTable(data=df.to_dict('records'), columns=[{'name': i, 'id': i} for i in df.columns])

  After:

  dash_table.DataTable(data=df.to_dict('records'))

  New Component Properties

  Checklist & RadioItems

  • A new property inline appends display: inline-block to labelStyle.

  dcc.Checklist(inline=True)

Fixed

• #1879 Delete redundancy in pattern-matching callback implementation, specifically when ALL and MATCH wildcards are used together. This patch was submitted by an anonymous Dash Enterprise customer. Many thanks!

• #1858 Support mini-css-extract-plugin Webpack plugin with @plotly/webpack-dash-dynamic-import node package - used by components to support dash async chunks. Updated dependencies of other @plotly node packages.

• #1836 Fix __all__ in dcc and table for extras: dcc download helpers and table format helpers. This also restores this functionality to the obsolete top-level packages dash_core_components and dash_table.

• #1822 Remove Radium from renderer dependencies, as part of investigating React 17 support.

• #1779:

  • Clean up our handling of serialization problems, including fixing orjson for Python 3.6
  • Added the ability for dash.testing percy_snapshot methods to choose widths to generate.

• #1778 DataTable: Fix React warnings stating
  that each child in a list should have a unique "key" prop

• #1895 Support debug=True if native namespace-packages are present

Dash v2.0.0

Dash and Dash Renderer

Added

• #1702 Added a new @app.long_callback decorator to support callback functions that take a long time to run. See the PR and documentation for more information.
• #1514 Perform json encoding using the active plotly JSON engine. This will default to the faster orjson encoder if the orjson package is installed.
• #1736 Add support for request_refresh_jwt hook and retry requests that used expired JWT tokens.

Changed

• #1679 Restructure dash, dash-core-components, dash-html-components, and dash-table into a singular monorepo and move component packages into dash. This change makes the component modules available for import within the dash namespace, and simplifies the import pattern for a Dash app. From a development standpoint, all future changes to component modules will be made within the components directory, and relevant packages updated with the dash-update-components CLI command.
• #1707 Change the default value of the compress argument to the dash.Dash constructor to False. This change reduces CPU usage, and was made in recognition of the fact that many deployment platforms (e.g. Dash Enterprise) already apply their own compression. If deploying to an environment that does not already provide compression, the Dash 1 behavior may be restored by adding compress=True to the dash.Dash constructor.
• #1734 Added npm run build script to simplify build process involving dash-renderer and subcomponent libraries within dash.

Dash Core Components

Added

• #1729 Include F#, C#, and MATLAB in markdown code highlighting, for the upcoming .NET and MATLAB flavors of dash.

• #1735 Upgrade Plotly.js to v2.4.2. This includes:

  • Feature release 2.3.0:
    • More number formatting options due to d3-format upgrade.
    • Many new geo projections.
    • Improved rendering and performance of scattergl, splom and parcoords traces.
  • Feature release 2.4.0:
    • legend.groupclick
    • bbox of hover items in event data, to support custom dash-driven hover effects
  • Patch releases 2.3.1, 2.4.1, and 2.4.2 containing various bug fixes.

• #1735 New dcc.Tooltip component. This is particularly useful for rich hover information on dcc.Graph charts, using the bbox information included in the event data in plotly.js v2.4.0

Dash Table

Added

• #1729 Include F#, C#, and MATLAB in markdown code highlighting, for the upcoming .NET and MATLAB flavors of dash.

Dash HTML Components

Removed

• #1734 Removed the following obsolete html elements - <command>, <element>, <isindex>, <listing>, <multicol>, <nextid>. These are obsolete and had been previously removed from the reference table.

Dash v1.21.0

Dash and Dash Renderer

Added

• #1675 Add new Dash constructor argument extra_hot_reload_paths. This allows you to re-initialize the Python code of the app when non-Python files change, if you know that these files impact the app.

Changed

• #1675 Remove the constraint that requests_pathname_prefix ends with routes_pathname_prefix. When you are serving your app behind a reverse proxy that rewrites URLs that constraint needs to be violated.
• #1611 and #1685 Package dash-renderer artifacts and dependencies with Dash, and source renderer resources from within Dash.
• #1567 Julia component generator puts components into src/jl - fixes an issue on case-insensitive filesystems when the component name and module name match (modulo case) and no prefix is used. Also reduces JS/Julia clutter in the overloaded src directory.

Fixed

• #1664 Fix #1649, makes the devtools readable with a dark theme.
• #1640 Fix #1475, missing timing_information after certain modifications to Flask behavior

Dash Core Components

Fixed

• #963 Fixes #885

  This applies the fix from #878 to the RangeSlider.
  It not only fixes the bug where the tooltips were visible when slider was not, but it also reduces the lag in the
  tooltip when the slider handles are moved.

Updated

• #939 Upgrade Plotly.js to v2.2.1. Note that this is a major version upgrade to Plotly.js, however we are not treating this as a breaking change for DCC as the majority of breaking changes in Plotly.js do not affect the Dash API. The one exception is that several trace types that have long been deprecated are removed entirely.
  • Major release 2.0.0:
    • Stop exporting d3 as Plotly.d3, and remove many other deep pieces of the public API. This does not affect the dcc.Graph component, but if you make use of Plotly from the global scope in some other way you may be affected.
    • Drop the deprecated trace types contourgl and area, as well as legacy pre-scatterpolar polar attributes bar.r, bar.t, scatter.r, scatter.t, layout.radialaxis, layout.angularaxis. Use scatterpolar, barpolar, and polar subplots instead.
    • heatmapgl and pointcloud trace types, and the transform attribute are deprecated, and will be removed in a future release.
    • Increase CSP safety by removing function constructors. 3D plots still use function constructors, but if you place one of the non-3D bundles (including the new strict bundle) in your assets folder you will have no function constructors.
    • Remove "Aa" text in legends.
    • Default hovermode to "closest".
    • Default textposition to "auto" in bar traces. If you previously used the bar.text attribute for hover only, you will need to explicitly set textposition="none".
    • Add bar.marker.pattern, image.zsmooth, and various other features and bugfixes.
  • Feature release 2.1.0:
    • New icicle trace type.
    • New legendrank trace attribute.
    • Several other additions and bug fixes.
  • Feature release 2.2.0:
    • Legend group titles
    • Half-year directive (%h) for date formatting
    • Several other bug fixes and performance improvements
  • Patch release 2.2.1 containing a security fix.

Added

• #932 Adds a new copy to clipboard component.
• #948] Adds disabled_days prop to DatePickerRange and DatePickerSingle components. With this prop you can specify days that should be made unselectable in the date picker, in addition to those that fall outside of the range specified by min_date_allowed and max_date_allowed.

Changed

• #972 Updated R package vignettes and dash-info.yaml to regenerate examples without attaching now-deprecated core component packages (dashHtmlComponents, dashCoreComponents, or dashTable).

Dash HTML Components

Changed

• #194 Updated dependencies and build process
• #190 Updated R package vignettes and dash-info.yaml to regenerate examples without attaching now-deprecated core component packages (dashHtmlComponents, dashCoreComponents, or dashTable).

Dash Table

Fixed

• #907
  • Fix a bug where pagination did not work or was not visible. #834
  • Fix a bug where if you are on a page that no longer exists after the data is updated, no data is displayed. #892

Added

• #916

  • Added html option to markdown_options prop. This enables the use of html tags in markdown text.

• #545

  • Case insensitive filtering
  • New props: filter_options - to control case of all filters, columns.filter_options - to control filter case for each column
  • New operators: i=, ieq, i>=, ige, i>, igt, i<=, ile, i<, ilt, i!=, ine, icontains - for case-insensitive filtering, s=, seq, s>=, sge, s>, sgt, s<=, sle, s<, slt, s!=, sne, scontains - to force case-sensitive filtering on case-insensitive columns

Changed

• #918 Updated all dependencies. In particular the highlight.js upgrade changes code highlighting in markdown: we have long used their "github" style, this has been updated to more closely match current github styles.
• #901 Updated R package dash-info.yaml to regenerate example without attaching now-deprecated core component packages (dashHtmlComponents, dashCoreComponents, or dashTable).