st-ant-menu 0.0.18__tar.gz

st_ant_menu-0.0.18/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 flucas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

st_ant_menu-0.0.18/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include st_ant_menu/frontend/build *

st_ant_menu-0.0.18/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: st_ant_menu
+Version: 0.0.18
+Summary: Streamlit Component for ANT Menu
+Home-page: https://github.com/flucas96/st_ant_menu
+Author: 
+Author-email: 
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: streamlit>=0.63
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Streamlit Ant Design Menu Component
+
+This custom Streamlit component allows you to easily integrate an Ant Design menu into your Streamlit application. The component is built using [Ant Design](https://ant.design/) and provides a simple interface for creating a menu with nested items and icons.
+
+<a href="https://flucas-component-overview.streamlit.app/?preselect=7" target="_blank">
+    <img src="https://img.shields.io/badge/Live%20Demo-Streamlit-red?style=for-the-badge&logo=streamlit" alt="Live Demo">
+</a>
+
+## Features
+
+- Hierarchical menu structure
+- Ant Design icons support
+- Light and dark theme support
+- Customizable CSS styling
+- Multiple selection (experimental)
+- Auto-adjusting menu height
+- Click event handling
+
+## Installation
+
+To install this component, simply run:
+
+```bash
+pip install st_ant_menu
+```
+
+# Usage
+
+First, import the **st_ant_menu** function from the package:
+```python
+from st_ant_menu import st_ant_menu
+```
+
+Then, create a menu data structure, and call st_ant_menu with the data:
+
+    menu_data = [
+    {
+        "key": "1",
+        "label": "Menu Item 1",
+        "icon": "UserOutlined",
+    },
+    {
+        "key": "2",
+        "label": "Menu Item 2",
+        "icon": "VideoCameraOutlined",
+        "disabled": True
+    },
+    {
+        "key": "3",
+        "label": "Menu Item 3",
+        "icon": "UploadOutlined",
+        "children": [
+            {
+                "key": "3-1",
+                "label": "Submenu Item 1",
+                "icon": "BarChartOutlined",
+            },
+            {
+                "key": "3-2",
+                "label": "Submenu Item 2",
+                "icon": "CloudOutlined",
+            },
+        ],
+    },
+    ]
+
+    selected_key = st_ant_menu(menu_data)
+
+
+# API
+
+    st_ant_menu(
+    menu_data: List[Dict],
+    key: str = "first_menu",
+    defaultValue: Optional[str] = None,
+    defaultSelectedKeys: Optional[str] = None,
+    defaultOpenKeys: Optional[str] = None,
+    additionalHeight: int = 100,
+    multiple: bool = False,
+    css_styling: Optional[Dict] = None,
+    theme: str = "light",
+    menu_click: bool = False
+    ) -> Union[str, List[str]]
+
+
+
+Parameters
+
+menu_data (List[Dict]): The data to be displayed in the menu. Must be a list of dictionaries that conform to the Ant Design Menu item specification. See https://ant.design/components/menu/#Menu.Item for more information.
+
+key (str, optional): The key associated with the component. This is used to ensure that the component is rendered properly when its value changes. Defaults to "first_menu".
+
+defaultValue (Optional[str], optional): The default value to be displayed in the component. Defaults to None.
+
+defaultSelectedKeys (Optional[str], optional): The default selected keys in the menu. Defaults to None.
+defaultOpenKeys (Optional[str], optional): The default open keys in the menu. Defaults to None.
+additionalHeight (int, optional): The additional height of the menu that should be added to the Streamlit iframe height. This is used to ensure that the entire menu is visible in the Streamlit app. Defaults to 100.
+multiple (bool, optional): Whether the menu allows multiple selections. (Broken) Defaults to False.
+css_styling (Optional[Dict], optional): A dictionary of CSS styling to be applied to the component. Defaults to None.
+theme (str, optional): The theme of the menu. Can be either "light" or "dark". Defaults to "light".
+menu_click (bool, optional): Set this to True to return the list of open keys on menu click, False will only return the selected key. Defaults to False.
+
+Returns
+
+Union[str, List[str]]: The value of the component. If menu_click is set to True, it will return a list of open keys, otherwise it will return the selected key.

st_ant_menu-0.0.18/README.md

@@ -0,0 +1,105 @@
+# Streamlit Ant Design Menu Component
+
+This custom Streamlit component allows you to easily integrate an Ant Design menu into your Streamlit application. The component is built using [Ant Design](https://ant.design/) and provides a simple interface for creating a menu with nested items and icons.
+
+<a href="https://flucas-component-overview.streamlit.app/?preselect=7" target="_blank">
+    <img src="https://img.shields.io/badge/Live%20Demo-Streamlit-red?style=for-the-badge&logo=streamlit" alt="Live Demo">
+</a>
+
+## Features
+
+- Hierarchical menu structure
+- Ant Design icons support
+- Light and dark theme support
+- Customizable CSS styling
+- Multiple selection (experimental)
+- Auto-adjusting menu height
+- Click event handling
+
+## Installation
+
+To install this component, simply run:
+
+```bash
+pip install st_ant_menu
+```
+
+# Usage
+
+First, import the **st_ant_menu** function from the package:
+```python
+from st_ant_menu import st_ant_menu
+```
+
+Then, create a menu data structure, and call st_ant_menu with the data:
+
+    menu_data = [
+    {
+        "key": "1",
+        "label": "Menu Item 1",
+        "icon": "UserOutlined",
+    },
+    {
+        "key": "2",
+        "label": "Menu Item 2",
+        "icon": "VideoCameraOutlined",
+        "disabled": True
+    },
+    {
+        "key": "3",
+        "label": "Menu Item 3",
+        "icon": "UploadOutlined",
+        "children": [
+            {
+                "key": "3-1",
+                "label": "Submenu Item 1",
+                "icon": "BarChartOutlined",
+            },
+            {
+                "key": "3-2",
+                "label": "Submenu Item 2",
+                "icon": "CloudOutlined",
+            },
+        ],
+    },
+    ]
+
+    selected_key = st_ant_menu(menu_data)
+
+
+# API
+
+    st_ant_menu(
+    menu_data: List[Dict],
+    key: str = "first_menu",
+    defaultValue: Optional[str] = None,
+    defaultSelectedKeys: Optional[str] = None,
+    defaultOpenKeys: Optional[str] = None,
+    additionalHeight: int = 100,
+    multiple: bool = False,
+    css_styling: Optional[Dict] = None,
+    theme: str = "light",
+    menu_click: bool = False
+    ) -> Union[str, List[str]]
+
+
+
+Parameters
+
+menu_data (List[Dict]): The data to be displayed in the menu. Must be a list of dictionaries that conform to the Ant Design Menu item specification. See https://ant.design/components/menu/#Menu.Item for more information.
+
+key (str, optional): The key associated with the component. This is used to ensure that the component is rendered properly when its value changes. Defaults to "first_menu".
+
+defaultValue (Optional[str], optional): The default value to be displayed in the component. Defaults to None.
+
+defaultSelectedKeys (Optional[str], optional): The default selected keys in the menu. Defaults to None.
+defaultOpenKeys (Optional[str], optional): The default open keys in the menu. Defaults to None.
+additionalHeight (int, optional): The additional height of the menu that should be added to the Streamlit iframe height. This is used to ensure that the entire menu is visible in the Streamlit app. Defaults to 100.
+multiple (bool, optional): Whether the menu allows multiple selections. (Broken) Defaults to False.
+css_styling (Optional[Dict], optional): A dictionary of CSS styling to be applied to the component. Defaults to None.
+theme (str, optional): The theme of the menu. Can be either "light" or "dark". Defaults to "light".
+menu_click (bool, optional): Set this to True to return the list of open keys on menu click, False will only return the selected key. Defaults to False.
+
+Returns
+
+Union[str, List[str]]: The value of the component. If menu_click is set to True, it will return a list of open keys, otherwise it will return the selected key.

st_ant_menu-0.0.18/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

st_ant_menu-0.0.18/setup.py

@@ -0,0 +1,26 @@
+import setuptools
+
+
+with open('README.md') as f:
+    long_desc = f.read()
+
+setuptools.setup(
+    name="st_ant_menu",
+    version="0.0.18",
+    author="",
+    author_email="",
+    description="Streamlit Component for ANT Menu",
+    long_description=long_desc,
+    long_description_content_type='text/markdown',
+    url="https://github.com/flucas96/st_ant_menu",
+    packages=setuptools.find_packages(),
+    include_package_data=True,
+    classifiers=[],
+    python_requires=">=3.6",
+    install_requires=[
+        # By definition, a Custom Component depends on Streamlit.
+        # If your component has other Python dependencies, list
+        # them here.
+        "streamlit >= 0.63",
+    ],
+)

st_ant_menu-0.0.18/st_ant_menu/__init__.py

@@ -0,0 +1,132 @@
+import streamlit.components.v1 as components
+import os
+
+_RELEASE = True
+
+if not _RELEASE:
+    # Declare the component with a given name and URL if we're not in release mode.
+    _component_func = components.declare_component(
+        # We give the component a simple, descriptive name ("my_component"
+        # does not fit this bill, so please choose something better for your
+        # own component :)
+        "st_ant_menu",
+        # Pass `url` here to tell Streamlit that the component will be served
+        # by the local dev server that you run via `npm run start`.
+        # (This is useful while your component is in development.)
+        url="http://localhost:3000",
+    )
+else:
+    # When we're distributing a production version of the component, we'll
+    # replace the `url` param with `path`, and point it to to the component's
+    # build directory:
+    parent_dir = os.path.dirname(os.path.abspath(__file__))
+    build_dir = os.path.join(parent_dir, "frontend/build")
+    _component_func = components.declare_component("st_ant_menu", path=build_dir)
+
+
+def validate_menu_data(menu_data):
+    if not isinstance(menu_data, list):
+        raise ValueError("menu_data must be a list of dictionaries")
+
+    for item in menu_data:
+        if not isinstance(item, dict):
+            raise ValueError("Each menu item must be a dictionary")
+
+        if "key" not in item or "label" not in item:
+            raise ValueError("Each menu item must have 'key' and 'label' fields")
+
+        if "label" in item and item["label"] is not None and not isinstance(item["label"], str):
+            raise ValueError("The 'label' field must be a string or null")
+
+        if "icon" in item and not isinstance(item["icon"], str):
+            raise ValueError("The 'icon' field must be a string")
+
+        if "children" in item:
+            if not isinstance(item["children"], list):
+                raise ValueError("The 'children' field must be a list of dictionaries")
+            validate_menu_data(item["children"])
+
+        if "type" in item and item["type"] not in [None, "group", "divider"]:
+            raise ValueError("The 'type' field must be either 'group', 'divider', or null")
+
+        if "disabled" in item and not isinstance(item["disabled"], bool):
+            raise ValueError("The 'disabled' field must be a boolean")
+
+
+def st_ant_menu(menu_data = None, key="first_menu", defaultValue=[], defaultSelectedKeys=[], defaultOpenKeys=[], additionalHeight=0, multiple=False, css_styling=None, css_styling_menu=None,
+                 generall_css_styling=None, theme="light",menu_click=False, iconSize=15, modus = "inline", inlineIndent=24, close_auto=True, custom_font_awesome_url = "https://kit.fontawesome.com/c7cbba6207.js",
+                 iconMinWidth=20,return_value=True) :
+    """
+    Create a menu component that can be used in Streamlit.
+
+    generall_css_styling example:
+
+    .ant-menu-item-divider {
+    /* Add your custom styles for the divider here */
+    border-top: 3px solid red !important;
+    }
+    
+
+    :param menu_data: The data to be displayed in the menu. Must be a list of dictionaries
+        that conform to the Ant Design Menu item specification. See
+        https://ant.design/components/menu/#Menu.Item for more information.
+    :param key: The key associated with the component. This is used to ensure that
+        the component is rendered properly when its value changes.
+    :param defaultValue: The default value to be displayed in the component.
+    :param defaultSelectedKeys: The default selected keys in the menu.
+    :param defaultOpenKeys: The default open keys in the menu.
+    :param additionalHeight: The additional height of the menu that should be added
+        to the Streamlit iframe height. This is used to ensure that the entire menu
+        is visible in the Streamlit app.
+    :param multiple: Whether the menu allows multiple selections. (Broken)
+    :param css_styling_menu: A dictionary of CSS styling to be applied to the Menu component.
+    :param theme: The theme of the menu. Can be either "light" or "dark".
+    :param iconSize: The size of the icons in the menu. Default is 15.
+    :param modus: The modus of the menu. Can be either "inline" or "horizontal".
+    :param inlineIndent: The indent of the menu items in inline modus. Default is 24.
+    :param close_auto: Whether the menus collapse if another one is opened. Default is True.
+    :param custom_font_awesome_url: The url of the font awesome library. Default is "https://kit.fontawesome.com/c7cbba6207.js".
+    :param iconMinWidth: The minimum width of the icons in the menu. Default is 30. - Used to make sure that the text always starts at the same position.
+    :param return_value: Whether the component should return a value. Default is True.
+
+    :return: The value of the component.
+    """
+    # css_styling is an alias for css_styling_menu (fixes #2)
+    if css_styling is not None and css_styling_menu is None:
+        css_styling_menu = css_styling
+
+    # Call the component function with the given parameters.
+    component_value = _component_func(
+        menu_data=menu_data,
+        key=key,
+        defaultSelectedKeys=defaultSelectedKeys,
+        defaultOpenKeys=defaultOpenKeys,
+        default=defaultValue,
+        multiple=multiple,
+        additionalHeight=additionalHeight,
+        css_styling_menu=css_styling_menu,
+        generall_css_styling=generall_css_styling,
+        theme = theme, 
+        menu_click = menu_click,
+        iconSize = iconSize,
+        modus = modus,
+        inlineIndent = inlineIndent,
+        close_auto = close_auto,
+        custom_font_awesome_url = custom_font_awesome_url,
+        iconMinWidth = iconMinWidth
+    )
+        # Return the component value, handling the case where it's a list.
+    if return_value == True:
+        if menu_click == True:
+            if isinstance(component_value, list):
+                return component_value[0] if len(component_value) == 1 else component_value[-1]
+            
+        if multiple == False:
+            if isinstance(component_value, list):
+                if len(component_value) == 0:
+                    return None
+                else:
+                    return component_value[0]
+            
+
+        return component_value

st_ant_menu-0.0.18/st_ant_menu/frontend/build/asset-manifest.json

@@ -0,0 +1,19 @@
+{
+  "files": {
+    "main.js": "./static/js/main.d3acb81e.chunk.js",
+    "main.js.map": "./static/js/main.d3acb81e.chunk.js.map",
+    "runtime-main.js": "./static/js/runtime-main.ac51b7c4.js",
+    "runtime-main.js.map": "./static/js/runtime-main.ac51b7c4.js.map",
+    "static/js/2.eb109dfa.chunk.js": "./static/js/2.eb109dfa.chunk.js",
+    "static/js/2.eb109dfa.chunk.js.map": "./static/js/2.eb109dfa.chunk.js.map",
+    "index.html": "./index.html",
+    "precache-manifest.05c7b8bb9328961b3aab59d9f6f17ff0.js": "./precache-manifest.05c7b8bb9328961b3aab59d9f6f17ff0.js",
+    "service-worker.js": "./service-worker.js",
+    "static/js/2.eb109dfa.chunk.js.LICENSE.txt": "./static/js/2.eb109dfa.chunk.js.LICENSE.txt"
+  },
+  "entrypoints": [
+    "static/js/runtime-main.ac51b7c4.js",
+    "static/js/2.eb109dfa.chunk.js",
+    "static/js/main.d3acb81e.chunk.js"
+  ]
+}