extra-streamlit-components API Reference

Python Library Documentation: package extra_streamlit_components.BouncingImage in extra_streamlit_components

NAME
    extra_streamlit_components.BouncingImage

PACKAGE CONTENTS


FUNCTIONS
    bouncing_image(image_source: str, animate: bool, animation_time: int, height: float, width: float)

DATA
    IS_RELEASE = True
    absolute_path = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyt...p...
    build_path = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyt...stre...

FILE
    c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\extra_streamlit_components\bouncingimage\__init__.py

Python Library Documentation: class CookieManager in module extra_streamlit_components.CookieManager

class CookieManager(builtins.object)
 |  CookieManager(key='init')
 |
 |  Methods defined here:
 |
 |  __init__(self, key='init')
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  batch_set(self, cookies: Dict[str, Union[str, int, float, bool]], path: str = '/', expires_at: Optional[datetime.datetime] = None, max_age: Optional[float] = None, domain: Optional[str] = None, secure: Optional[bool] = None, same_site: Union[bool, NoneType, Literal['lax', 'strict']] = 'strict')
 |
 |  delete(self, cookie, key='delete')
 |
 |  get(self, cookie: str)
 |
 |  get_all(self, key='get_all')
 |
 |  set(self, cookie: str, val: Union[str, int, float, bool], key: str = 'set', path: str = '/', expires_at: Optional[datetime.datetime] = None, max_age: Optional[float] = None, domain: Optional[str] = None, secure: Optional[bool] = None, same_site: Union[bool, NoneType, Literal['lax', 'strict']] = 'strict')
 |      Sets a cookie with the given name and value.
 |
 |      Args:
 |          cookie: The name of the cookie to set.
 |          val: The value of the cookie.
 |          key: The key to use for the component.
 |          path: Cookie path. Use '/' as the path if you want your cookie to be accessible on all pages.
 |          expires_at: Absolute expiration date for the cookie. Defaults to 1 day from now.
 |          max_age: Relative max age of the cookie from when the client receives it in seconds.
 |          domain: Domain for the cookie (sub.domain.com or .allsubdomains.com)
 |          secure: Is only accessible through HTTPS?
 |          same_site: Strict or Lax enforcement.
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

Python Library Documentation: bool object

class bool(int)
 |  bool(x) -> bool
 |
 |  Returns True when the argument x is true, False otherwise.
 |  The builtins True and False are the only two instances of the class bool.
 |  The class bool is a subclass of the class int, and cannot be subclassed.
 |
 |  Method resolution order:
 |      bool
 |      int
 |      object
 |
 |  Methods defined here:
 |
 |  __and__(self, value, /)
 |      Return self&value.
 |
 |  __invert__(self, /)
 |      ~self
 |
 |  __or__(self, value, /)
 |      Return self|value.
 |
 |  __rand__(self, value, /)
 |      Return value&self.
 |
 |  __repr__(self, /)
 |      Return repr(self).
 |
 |  __ror__(self, value, /)
 |      Return value|self.
 |
 |  __rxor__(self, value, /)
 |      Return value^self.
 |
 |  __xor__(self, value, /)
 |      Return self^value.
 |
 |  ----------------------------------------------------------------------
 |  Static methods defined here:
 |
 |  __new__(*args, **kwargs)
 |      Create and return a new object.  See help(type) for accurate signature.
 |
 |  ----------------------------------------------------------------------
 |  Methods inherited from int:
 |
 |  __abs__(self, /)
 |      abs(self)
 |
 |  __add__(self, value, /)
 |      Return self+value.
 |
 |  __bool__(self, /)
 |      True if self else False
 |
 |  __ceil__(...)
 |      Ceiling of an Integral returns itself.
 |
 |  __divmod__(self, value, /)
 |      Return divmod(self, value).
 |
 |  __eq__(self, value, /)
 |      Return self==value.
 |
 |  __float__(self, /)
 |      float(self)
 |
 |  __floor__(...)
 |      Flooring an Integral returns itself.
 |
 |  __floordiv__(self, value, /)
 |      Return self//value.
 |
 |  __format__(self, format_spec, /)
 |      Convert to a string according to format_spec.
 |
 |  __ge__(self, value, /)
 |      Return self>=value.
 |
 |  __getattribute__(self, name, /)
 |      Return getattr(self, name).
 |
 |  __getnewargs__(self, /)
 |
 |  __gt__(self, value, /)
 |      Return self>value.
 |
 |  __hash__(self, /)
 |      Return hash(self).
 |
 |  __index__(self, /)
 |      Return self converted to an integer, if self is suitable for use as an index into a list.
 |
 |  __int__(self, /)
 |      int(self)
 |
 |  __le__(self, value, /)
 |      Return self<=value.
 |
 |  __lshift__(self, value, /)
 |      Return self<<value.
 |
 |  __lt__(self, value, /)
 |      Return self<value.
 |
 |  __mod__(self, value, /)
 |      Return self%value.
 |
 |  __mul__(self, value, /)
 |      Return self*value.
 |
 |  __ne__(self, value, /)
 |      Return self!=value.
 |
 |  __neg__(self, /)
 |      -self
 |
 |  __pos__(self, /)
 |      +self
 |
 |  __pow__(self, value, mod=None, /)
 |      Return pow(self, value, mod).
 |
 |  __radd__(self, value, /)
 |      Return value+self.
 |
 |  __rdivmod__(self, value, /)
 |      Return divmod(value, self).
 |
 |  __rfloordiv__(self, value, /)
 |      Return value//self.
 |
 |  __rlshift__(self, value, /)
 |      Return value<<self.
 |
 |  __rmod__(self, value, /)
 |      Return value%self.
 |
 |  __rmul__(self, value, /)
 |      Return value*self.
 |
 |  __round__(...)
 |      Rounding an Integral returns itself.
 |
 |      Rounding with an ndigits argument also returns an integer.
 |
 |  __rpow__(self, value, mod=None, /)
 |      Return pow(value, self, mod).
 |
 |  __rrshift__(self, value, /)
 |      Return value>>self.
 |
 |  __rshift__(self, value, /)
 |      Return self>>value.
 |
 |  __rsub__(self, value, /)
 |      Return value-self.
 |
 |  __rtruediv__(self, value, /)
 |      Return value/self.
 |
 |  __sizeof__(self, /)
 |      Returns size in memory, in bytes.
 |
 |  __sub__(self, value, /)
 |      Return self-value.
 |
 |  __truediv__(self, value, /)
 |      Return self/value.
 |
 |  __trunc__(...)
 |      Truncating an Integral returns itself.
 |
 |  as_integer_ratio(self, /)
 |      Return a pair of integers, whose ratio is equal to the original int.
 |
 |      The ratio is in lowest terms and has a positive denominator.
 |
 |      >>> (10).as_integer_ratio()
 |      (10, 1)
 |      >>> (-10).as_integer_ratio()
 |      (-10, 1)
 |      >>> (0).as_integer_ratio()
 |      (0, 1)
 |
 |  bit_count(self, /)
 |      Number of ones in the binary representation of the absolute value of self.
 |
 |      Also known as the population count.
 |
 |      >>> bin(13)
 |      '0b1101'
 |      >>> (13).bit_count()
 |      3
 |
 |  bit_length(self, /)
 |      Number of bits necessary to represent self in binary.
 |
 |      >>> bin(37)
 |      '0b100101'
 |      >>> (37).bit_length()
 |      6
 |
 |  conjugate(...)
 |      Returns self, the complex conjugate of any int.
 |
 |  is_integer(self, /)
 |      Returns True. Exists for duck type compatibility with float.is_integer.
 |
 |  to_bytes(self, /, length=1, byteorder='big', *, signed=False)
 |      Return an array of bytes representing an integer.
 |
 |      length
 |        Length of bytes object to use.  An OverflowError is raised if the
 |        integer is not representable with the given number of bytes.  Default
 |        is length 1.
 |      byteorder
 |        The byte order used to represent the integer.  If byteorder is 'big',
 |        the most significant byte is at the beginning of the byte array.  If
 |        byteorder is 'little', the most significant byte is at the end of the
 |        byte array.  To request the native byte order of the host system, use
 |        `sys.byteorder' as the byte order value.  Default is to use 'big'.
 |      signed
 |        Determines whether two's complement is used to represent the integer.
 |        If signed is False and a negative integer is given, an OverflowError
 |        is raised.
 |
 |  ----------------------------------------------------------------------
 |  Class methods inherited from int:
 |
 |  from_bytes(bytes, byteorder='big', *, signed=False)
 |      Return the integer represented by the given array of bytes.
 |
 |      bytes
 |        Holds the array of bytes to convert.  The argument must either
 |        support the buffer protocol or be an iterable object producing bytes.
 |        Bytes and bytearray are examples of built-in objects that support the
 |        buffer protocol.
 |      byteorder
 |        The byte order used to represent the integer.  If byteorder is 'big',
 |        the most significant byte is at the beginning of the byte array.  If
 |        byteorder is 'little', the most significant byte is at the end of the
 |        byte array.  To request the native byte order of the host system, use
 |        `sys.byteorder' as the byte order value.  Default is to use 'big'.
 |      signed
 |        Indicates whether two's complement is used to represent the integer.
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors inherited from int:
 |
 |  denominator
 |      the denominator of a rational number in lowest terms
 |
 |  imag
 |      the imaginary part of a complex number
 |
 |  numerator
 |      the numerator of a rational number in lowest terms
 |
 |  real
 |      the real part of a complex number

Python Library Documentation: class Router in module extra_streamlit_components.Router

class Router(builtins.object)
 |  Router(routes: dict, **kwargs)
 |
 |  Methods defined here:
 |
 |  __init__(self, routes: dict, **kwargs)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  get_nav_query_param(self)
 |
 |  get_url_route(self)
 |
 |  route(self, new_route)
 |
 |  show_route_view(self)
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object

Python Library Documentation: package extra_streamlit_components.StepperBar in extra_streamlit_components

NAME
    extra_streamlit_components.StepperBar

PACKAGE CONTENTS


FUNCTIONS
    stepper_bar(steps: List[str], is_vertical: bool = False, lock_sequence: bool = True, default: int = 0) -> streamlit.components.v1.custom_component.CustomComponent

DATA
    IS_RELEASE = True
    List = typing.List
        A generic version of list.

    absolute_path = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyt...t...
    build_path = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyt...ra_s...

FILE
    c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\extra_streamlit_components\stepperbar\__init__.py

Python Library Documentation: package extra_streamlit_components.TabBar in extra_streamlit_components

NAME
    extra_streamlit_components.TabBar

PACKAGE CONTENTS


CLASSES
    builtins.object
        TabBarItemData

    class TabBarItemData(builtins.object)
     |  TabBarItemData(id: int, title: str, description: str) -> None
     |
     |  TabBarItemData(id: int, title: str, description: str)
     |
     |  Methods defined here:
     |
     |  __delattr__(self, name)
     |      Implement delattr(self, name).
     |
     |  __eq__(self, other)
     |      Return self==value.
     |
     |  __ge__(self, other)
     |      Return self>=value.
     |
     |  __gt__(self, other)
     |      Return self>value.
     |
     |  __hash__(self)
     |      Return hash(self).
     |
     |  __init__(self, id: int, title: str, description: str) -> None
     |      Initialize self.  See help(type(self)) for accurate signature.
     |
     |  __le__(self, other)
     |      Return self<=value.
     |
     |  __lt__(self, other)
     |      Return self<value.
     |
     |  __repr__(self)
     |      Return repr(self).
     |
     |  __setattr__(self, name, value)
     |      Implement setattr(self, name, value).
     |
     |  to_dict(self)
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  __dict__
     |      dictionary for instance variables
     |
     |  __weakref__
     |      list of weak references to the object
     |
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |
     |  __annotations__ = {'description': <class 'str'>, 'id': <class 'int'>, ...
     |
     |  __dataclass_fields__ = {'description': Field(name='description',type=<...
     |
     |  __dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,or...
     |
     |  __match_args__ = ('id', 'title', 'description')

FUNCTIONS
    tab_bar(data: List[extra_streamlit_components.TabBar.TabBarItemData], default=None, return_type=<class 'str'>, key=None)

DATA
    IS_RELEASE = True
    List = typing.List
        A generic version of list.

    absolute_path = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyt...b...
    build_path = r'C:\Users\Youse\AppData\Local\Programs\Python\Pyt...\ext...

FILE
    c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\extra_streamlit_components\tabbar\__init__.py

Python Library Documentation: class TabBarItemData in module extra_streamlit_components.TabBar

class TabBarItemData(builtins.object)
 |  TabBarItemData(id: int, title: str, description: str) -> None
 |
 |  TabBarItemData(id: int, title: str, description: str)
 |
 |  Methods defined here:
 |
 |  __delattr__(self, name)
 |      Implement delattr(self, name).
 |
 |  __eq__(self, other)
 |      Return self==value.
 |
 |  __ge__(self, other)
 |      Return self>=value.
 |
 |  __gt__(self, other)
 |      Return self>value.
 |
 |  __hash__(self)
 |      Return hash(self).
 |
 |  __init__(self, id: int, title: str, description: str) -> None
 |      Initialize self.  See help(type(self)) for accurate signature.
 |
 |  __le__(self, other)
 |      Return self<=value.
 |
 |  __lt__(self, other)
 |      Return self<value.
 |
 |  __repr__(self)
 |      Return repr(self).
 |
 |  __setattr__(self, name, value)
 |      Implement setattr(self, name, value).
 |
 |  to_dict(self)
 |
 |  ----------------------------------------------------------------------
 |  Data descriptors defined here:
 |
 |  __dict__
 |      dictionary for instance variables
 |
 |  __weakref__
 |      list of weak references to the object
 |
 |  ----------------------------------------------------------------------
 |  Data and other attributes defined here:
 |
 |  __annotations__ = {'description': <class 'str'>, 'id': <class 'int'>, ...
 |
 |  __dataclass_fields__ = {'description': Field(name='description',type=<...
 |
 |  __dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,or...
 |
 |  __match_args__ = ('id', 'title', 'description')

Python Library Documentation: function bouncing_image in module extra_streamlit_components.BouncingImage

bouncing_image(image_source: str, animate: bool, animation_time: int, height: float, width: float)

Python Library Documentation: function stepper_bar in module extra_streamlit_components.StepperBar

stepper_bar(steps: List[str], is_vertical: bool = False, lock_sequence: bool = True, default: int = 0) -> streamlit.components.v1.custom_component.CustomComponent

Python Library Documentation: function tab_bar in module extra_streamlit_components.TabBar

tab_bar(data: List[extra_streamlit_components.TabBar.TabBarItemData], default=None, return_type=<class 'str'>, key=None)