:tocdepth: 3

:py:mod:`gws.base.client.core`
==============================

.. py:module:: gws.base.client.core


**Source code:** :source:`gws.base.client.core<gws/base/client/core.py>`



Module Contents
---------------



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   GWS client configuration

   .. py:attribute:: addElements
      :type:  Optional[list[ElementConfig]]

      add elements to the parent element list

   .. py:attribute:: elements
      :type:  Optional[list[ElementConfig]]

      client UI elements

   .. py:attribute:: options
      :type:  Optional[dict]

      client options

   .. py:attribute:: removeElements
      :type:  Optional[list[ElementConfig]]

      remove elements from the parent element list


.. py:class:: Element


   Bases: :py:obj:`gws.Node`

   Configurable GWS object.

   .. py:attribute:: after
      :type:  str

   .. py:attribute:: before
      :type:  str

   .. py:attribute:: tag
      :type:  str

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: props(user)

      Generate a ``Props`` struct for this object.

      :param user: The user for which the props should be generated.



.. py:class:: ElementConfig(*args, **kwargs)


   Bases: :py:obj:`gws.ConfigWithAccess`

   GWS client UI element configuration

   .. py:attribute:: after
      :type:  str
      :value: ''


      insert after this tag

   .. py:attribute:: before
      :type:  str
      :value: ''


      insert before this tag

   .. py:attribute:: tag
      :type:  str

      element tag


.. py:class:: ElementProps(*args, **kwargs)


   Bases: :py:obj:`gws.Data`

   Basic data object.

   This object can be instantiated by passing one or or ``dict`` arguments
   and/or keyword args. All dicts keys and keywords become attributes of the object.

   Accessing an undefined attribute returns ``None`` and no error is raised,
   unless the attribute name starts with an underscore.

   .. py:attribute:: tag
      :type:  str


.. py:class:: Object


   Bases: :py:obj:`gws.Client`

   GWS Client control object.

   .. py:attribute:: elements
      :type:  list[Element]

   .. py:attribute:: options
      :type:  dict

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: props(user)

      Generate a ``Props`` struct for this object.

      :param user: The user for which the props should be generated.



.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.Data`

   Basic data object.

   This object can be instantiated by passing one or or ``dict`` arguments
   and/or keyword args. All dicts keys and keywords become attributes of the object.

   Accessing an undefined attribute returns ``None`` and no error is raised,
   unless the attribute name starts with an underscore.

   .. py:attribute:: elements
      :type:  Optional[list[ElementProps]]

   .. py:attribute:: options
      :type:  Optional[dict]