diff --git a/examples/reference/widgets/FloatInput.ipynb b/examples/reference/widgets/FloatInput.ipynb new file mode 100644 index 00000000000..552cce7eb63 --- /dev/null +++ b/examples/reference/widgets/FloatInput.ipynb @@ -0,0 +1,113 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "import panel as pn\n", + "pn.extension()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "The ``FloatInput`` widget allows entering any floating point value using a text entry box whose contents are then converted to a Python float. The widget only supports floats.\n", + "\n", + "For more information about listening to widget events and laying out widgets refer to the [widgets user guide](../../user_guide/Widgets.ipynb). Alternatively you can learn how to build GUIs by declaring parameters independently of any specific widgets in the [param user guide](../../user_guide/Param.ipynb). To express interactivity entirely using Javascript without the need for a Python server take a look at the [links user guide](../../user_guide/Param.ipynb).\n", + "\n", + "#### Parameters:\n", + "\n", + "For layout and styling related parameters see the [customization user guide](../../user_guide/Customization.ipynb).\n", + "\n", + "##### Core\n", + "\n", + "* **``value``** (float): Float value\n", + "* **``format``** (string): Optional format to convert the float value in string, see : http://numbrojs.com/old-format.html\n", + "\n", + "\n", + "##### Display\n", + "\n", + "* **``disabled``** (boolean): Whether the widget is editable\n", + "* **``name``** (str): The title of the widget\n", + "* **``placeholder``** (str): A placeholder string displayed when no value is entered\n", + "\n", + "___" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "float_input = pn.widgets.IntInput(name='Integer Input', value=None, placeholder='Enter an integer', format=\"0 $\")\n", + "float_input" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "``IntInput.value`` returns the value of the widget" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "int_input.value" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Controls\n", + "\n", + "The `IntInput` widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "pn.Row(int_input.controls(jslink=True), int_input)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.5" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/examples/reference/widgets/FloatSpinner.ipynb b/examples/reference/widgets/FloatSpinner.ipynb index 27867b01754..56dfebb57a6 100644 --- a/examples/reference/widgets/FloatSpinner.ipynb +++ b/examples/reference/widgets/FloatSpinner.ipynb @@ -30,13 +30,16 @@ "* **``step``** (float): The step added or subtracted to the current value on each click\n", "* **``start``** (float): Optional minimum allowable value\n", "* **``end``** (float): Optional maximum allowable value\n", - "* **``format``** (string): Optional format to convert the float value in string, see : http://numbrojs.com/old-format.html\n", + "* **``format``** (str): Optional format to convert the float value in string, see : http://numbrojs.com/old-format.html\n", "* **``page_step_multiplier``** (int): Defines the multiplication factor applied to step when the page up and page down keys are pressed.\n", "\n", "##### Display\n", "\n", "* **``disabled``** (boolean): Whether the widget is editable\n", - "* **``name``** (str): The title of the widget" + "* **``name``** (str): The title of the widget\n", + "* **``placeholder``** (str): A placeholder string displayed when no value is entered\n", + "\n", + "___" ] }, { @@ -93,9 +96,22 @@ } ], "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", "name": "python", - "pygments_lexer": "ipython3" + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.5" } }, "nbformat": 4, diff --git a/examples/reference/widgets/IntInput.ipynb b/examples/reference/widgets/IntInput.ipynb new file mode 100644 index 00000000000..bd4ffacf88e --- /dev/null +++ b/examples/reference/widgets/IntInput.ipynb @@ -0,0 +1,113 @@ +{ + "cells": [ + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "import panel as pn\n", + "pn.extension()" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "The ``IntInput`` widget allows entering any integer value using a text entry box whose contents are then converted to an integer. The widget only supports integers.\n", + "\n", + "For more information about listening to widget events and laying out widgets refer to the [widgets user guide](../../user_guide/Widgets.ipynb). Alternatively you can learn how to build GUIs by declaring parameters independently of any specific widgets in the [param user guide](../../user_guide/Param.ipynb). To express interactivity entirely using Javascript without the need for a Python server take a look at the [links user guide](../../user_guide/Param.ipynb).\n", + "\n", + "#### Parameters:\n", + "\n", + "For layout and styling related parameters see the [customization user guide](../../user_guide/Customization.ipynb).\n", + "\n", + "##### Core\n", + "\n", + "* **``value``** (int): Integer value\n", + "* **``format``** (string): Optional format to convert the integer value in string, see : http://numbrojs.com/old-format.html\n", + "\n", + "\n", + "##### Display\n", + "\n", + "* **``disabled``** (boolean): Whether the widget is editable\n", + "* **``name``** (str): The title of the widget\n", + "* **``placeholder``** (str): A placeholder string displayed when no value is entered\n", + "\n", + "___" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "int_input = pn.widgets.IntInput(name='Integer Input', value=None, placeholder='Enter an integer', format=\"0 $\")\n", + "int_input" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "``IntInput.value`` returns the value of the widget" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "int_input.value" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Controls\n", + "\n", + "The `IntInput` widget exposes a number of options which can be changed from both Python and Javascript. Try out the effect of these parameters interactively:" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [ + "pn.Row(int_input.controls(jslink=True), int_input)" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + } + ], + "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, + "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", + "name": "python", + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.5" + } + }, + "nbformat": 4, + "nbformat_minor": 4 +} diff --git a/examples/reference/widgets/IntSpinner.ipynb b/examples/reference/widgets/IntSpinner.ipynb index 6202e0be0a5..1d194cdc9e1 100644 --- a/examples/reference/widgets/IntSpinner.ipynb +++ b/examples/reference/widgets/IntSpinner.ipynb @@ -30,13 +30,16 @@ "* **``step``** (int): The step added or subtracted to the current value on each click\n", "* **``start``** (int): Optional minimum allowable value\n", "* **``end``** (int): Optional maximum allowable value\n", - "* **``format``** (string): Optional format to convert the float value in string, see : http://numbrojs.com/old-format.html\n", + "* **``format``** (str): Optional format to convert the float value in string, see : http://numbrojs.com/old-format.html\n", "* **``page_step_multiplier``** (int): Defines the multiplication factor applied to step when the page up and page down keys are pressed.\n", "\n", "##### Display\n", "\n", "* **``disabled``** (boolean): Whether the widget is editable\n", - "* **``name``** (str): The title of the widget" + "* **``name``** (str): The title of the widget\n", + "* **``placeholder``** (str): A placeholder string displayed when no value is entered\n", + "\n", + "___" ] }, { @@ -93,9 +96,22 @@ } ], "metadata": { + "kernelspec": { + "display_name": "Python 3", + "language": "python", + "name": "python3" + }, "language_info": { + "codemirror_mode": { + "name": "ipython", + "version": 3 + }, + "file_extension": ".py", + "mimetype": "text/x-python", "name": "python", - "pygments_lexer": "ipython3" + "nbconvert_exporter": "python", + "pygments_lexer": "ipython3", + "version": "3.8.5" } }, "nbformat": 4, diff --git a/panel/widgets/input.py b/panel/widgets/input.py index ce95d09e0a1..3b6edaadd0e 100644 --- a/panel/widgets/input.py +++ b/panel/widgets/input.py @@ -166,7 +166,8 @@ class _NumericInputBase(Widget): value = param.Number(default=0, allow_None=True, doc=""" The initial value of the spinner.""") - placeholder = param.String(default='0') + placeholder = param.String(default='0', doc=""" + Placeholder for empty input field.""") format = param.String(default=None, allow_None=True, doc=""" Number formating : http://numbrojs.com/old-format.html .""")