st-repeating-field-group 0.1.0

A Streamlit plugin for creating repeating field groups

st-repeating-field-group

A Streamlit plugin for creating dynamic, repeating field groups with add/remove functionality and conditional field display.

Installation

Install the package using pip:

pip install st-repeating-field-group

Features

• Create repeating groups of form fields
• Dynamically add and remove field groups
• Support for various field types: text, number, date, checkbox, toggle, slider, and dropdown
• Conditional field display based on other field values
• Customizable default values

Usage

Basic Usage

Here's a simple example of how to use the generate_repeating_field_group function:

import streamlit as st
from st_repeating_field_group import generate_repeating_field_group

keys = {
    "name": {"type": str, "default": ""},
    "age": {"type": int, "default": 0},
    "is_student": {"type": "checkbox", "default": False}
}

group_id = "example_group"
default_values = [
    {"name": "John Doe", "age": 30, "is_student": False},
    {"name": "Jane Smith", "age": 25, "is_student": True}
]

rows = generate_repeating_field_group(keys, group_id, default_values)

st.write(rows)

Advanced Usage with Conditional Fields

You can use the only_show_if parameter to conditionally display fields based on the values of other fields in the same group. Here's an example:

import streamlit as st
from st_repeating_field_group import generate_repeating_field_group

keys = {
    "name": {"type": str, "default": ""},
    "age": {"type": int, "default": 0},
    "is_student": {"type": "checkbox", "default": False},
    "school_name": {
        "type": str,
        "default": "",
        "only_show_if": {
            "kwargs": {"is_student": "is_student"},
            "func": lambda is_student: is_student
        }
    },
    "job_title": {
        "type": str,
        "default": "",
        "only_show_if": {
            "kwargs": {"is_student": "is_student"},
            "func": lambda is_student: not is_student
        }
    }
}

group_id = "advanced_example_group"
default_values = [
    {"name": "John Doe", "age": 30, "is_student": False, "job_title": "Engineer"},
    {"name": "Jane Smith", "age": 25, "is_student": True, "school_name": "University XYZ"}
]

rows = generate_repeating_field_group(keys, group_id, default_values)

st.write(rows)

In this example, the "school_name" field will only be displayed if "is_student" is checked, and the "job_title" field will only be displayed if "is_student" is not checked.

Supported Field Types

The generate_repeating_field_group function supports the following field types:

• str: Text input
• int: Integer input
• float: Float input
• "choice": Dropdown selection
• "date": Date input
• "toggle_switch": Toggle switch
• "checkbox": Checkbox
• "slider": Slider input

Parameters

• keys (dict): A dictionary defining the fields and their properties.
• group_id (str): A unique identifier for the field group.
• default_values (list, optional): Default values for the fields.

Field Properties

Each field in the keys dictionary can have the following properties:

• type: The data type or input type of the field (required).
• default: The default value for the field (required).
• choices: A list of options for dropdown fields (required for "choice" type).
• min: Minimum value for numeric or slider fields (optional).
• max: Maximum value for numeric or slider fields (optional).
• step: Step size for numeric or slider fields (optional).
• only_show_if: A dictionary containing conditional display logic (optional).

Using only_show_if

The only_show_if property allows you to conditionally display fields based on the values of other fields in the same group. It has two sub-properties:

• kwargs: A dictionary mapping parameter names to field names in the current group.
• func: A function that takes the mapped field values as arguments and returns a boolean indicating whether the field should be displayed.

Example:

"school_name": {
    "type": str,
    "default": "",
    "only_show_if": {
        "kwargs": {"is_student": "is_student"},
        "func": lambda is_student: is_student
    }
}

In this example, the "school_name" field will only be displayed if the "is_student" checkbox is checked.

License

This project is licensed under the MIT License - see the LICENSE file for details.