#-----------------------------------------------------------------------------
# Copyright (c) 2012 - 2021, Anaconda, Inc., and Bokeh Contributors.
# All rights reserved.
#
# The full license is in the file LICENSE.txt, distributed with this software.
#-----------------------------------------------------------------------------
''' Various kinds of input widgets and form controls.
'''
#-----------------------------------------------------------------------------
# Boilerplate
#-----------------------------------------------------------------------------
from __future__ import annotations
import logging # isort:skip
log = logging.getLogger(__name__)
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
# Bokeh imports
from ...core.enums import CalendarPosition
from ...core.has_props import abstract
from ...core.properties import (
Bool,
ColorHex,
Date,
Dict,
Either,
Enum,
Float,
Instance,
Int,
Interval,
List,
Null,
Nullable,
Override,
PositiveInt,
Readonly,
String,
Tuple,
)
from ..formatters import TickFormatter
from .widget import Widget
#-----------------------------------------------------------------------------
# Globals and constants
#-----------------------------------------------------------------------------
__all__ = (
'AutocompleteInput',
'ColorPicker',
'DatePicker',
'FileInput',
'InputWidget',
'MultiChoice',
'MultiSelect',
'NumericInput',
'PasswordInput',
'Select',
'Spinner',
'TextInput',
'TextAreaInput'
)
#-----------------------------------------------------------------------------
# Dev API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# General API
#-----------------------------------------------------------------------------
[docs]class Spinner(NumericInput):
''' Numeric Spinner input widget.
'''
def __init__(self, **kwargs) -> None:
if "value" in kwargs and "value_throttled" not in kwargs:
kwargs["value_throttled"] = kwargs["value"]
super().__init__(**kwargs)
value_throttled = Readonly(Either(Null, Float, Int), help="""
value reported at the end of interactions
""")
mode = Override(default="float")
step = Interval(Float, start=1e-16, end=float('inf'), default=1, help="""
The step added or subtracted to the current value
""")
page_step_multiplier = Interval(Float, start=0, end=float('inf'), default=10, help="""
Defines the multiplication factor applied to step when the page up and page
down keys are pressed
""")
wheel_wait = Either(Int, Float, default=100, help="""
Defines the debounce time in ms before updating `value_throttled` when the
mouse wheel is used to change the input
""")
class TextLikeInput(InputWidget):
''' Base class for text-like input widgets.
'''
value = String(default="", help="""
Initial or entered text value.
Change events are triggered whenever <enter> is pressed.
""")
value_input = String(default="", help="""
Initial or current value.
Change events are triggered whenever any update happens, i.e. on every
keypress.
""")
placeholder = String(default="", help="""
Placeholder for empty input field.
""")
max_length = Nullable(Int, help="""
Max count of characters in field
""")
[docs]class TextInput(TextLikeInput):
''' Single-line input widget.
'''
[docs]class TextAreaInput(TextLikeInput):
''' Multi-line input widget.
'''
cols = Int(default=20, help="""
Specifies the width of the text area (in average character width). Default: 20
""")
rows = Int(default=2, help="""
Specifies the height of the text area (in lines). Default: 2
""")
max_length = Override(default=500)
[docs]class Select(InputWidget):
''' Single-select widget.
'''
options = Either(List(Either(String, Tuple(String, String))),
Dict(String, List(Either(String, Tuple(String, String)))), help="""
Available selection options. Options may be provided either as a list of
possible string values, or as a list of tuples, each of the form
``(value, label)``. In the latter case, the visible widget text for each
value will be corresponding given label. Option groupings can be provided
by supplying a dictionary object whose values are in the aforementioned
list format
""").accepts(List(Either(Null, String)), lambda v: [ "" if item is None else item for item in v ])
value = String(default="", help="""
Initial or selected value.
""").accepts(Null, lambda _: "")
[docs]class MultiSelect(InputWidget):
''' Multi-select widget.
'''
options = List(Either(String, Tuple(String, String)), help="""
Available selection options. Options may be provided either as a list of
possible string values, or as a list of tuples, each of the form
``(value, label)``. In the latter case, the visible widget text for each
value will be corresponding given label.
""")
value = List(String, help="""
Initial or selected values.
""")
size = Int(default=4, help="""
The number of visible options in the dropdown list. (This uses the
``select`` HTML element's ``size`` attribute. Some browsers might not
show less than 3 options.)
""")
[docs]class MultiChoice(InputWidget):
''' MultiChoice widget.
'''
options = List(Either(String, Tuple(String, String)), help="""
Available selection options. Options may be provided either as a list of
possible string values, or as a list of tuples, each of the form
``(value, label)``. In the latter case, the visible widget text for each
value will be corresponding given label.
""")
value = List(String, help="""
Initial or selected values.
""")
delete_button = Bool(default=True, help="""
Whether to add a button to remove a selected option.
""")
max_items = Nullable(Int, help="""
The maximum number of items that can be selected.
""")
option_limit = Nullable(Int, help="""
The number of choices that will be rendered in the dropdown.
""")
search_option_limit = Nullable(Int, help="""
The number of choices that will be rendered in the dropdown
when search string is entered.
""")
placeholder = Nullable(String, help="""
A string that is displayed if not item is added.
""")
solid = Bool(default=True, help="""
Specify whether the choices should be solidly filled.""")
[docs]class DatePicker(InputWidget):
''' Calendar-based date picker widget.
'''
value = Date(help="""
The initial or picked date.
""")
min_date = Nullable(Date, help="""
Optional earliest allowable date.
""")
max_date = Nullable(Date, help="""
Optional latest allowable date.
""")
disabled_dates = List(Either(Date, Tuple(Date, Date)), default=[], help="""
A list of dates of ``(start, end)`` date ranges to make unavailable for
selection. All other dates will be avalable.
.. note::
Only one of ``disabled_dates`` and ``enabled_dates`` should be specified.
""")
enabled_dates = List(Either(Date, Tuple(Date, Date)), default=[], help="""
A list of dates of ``(start, end)`` date ranges to make available for
selection. All other dates will be unavailable.
.. note::
Only one of ``disabled_dates`` and ``enabled_dates`` should be specified.
""")
position = Enum(CalendarPosition, default="auto", help="""
Where the calendar is rendered relative to the input when ``inline`` is False.
""")
inline = Bool(default=False, help="""
Whether the calendar sholud be displayed inline.
""")
[docs]class ColorPicker(InputWidget):
''' Color picker widget
.. warning::
This widget as a limited support on *Internet Explorer* (it will be displayed
as a simple text input).
'''
color = ColorHex(default='#000000', help="""
The initial color of the picked color (named or hexadecimal)
""")
#-----------------------------------------------------------------------------
# Private API
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Code
#-----------------------------------------------------------------------------