Source code for gws.common.client

import gws
import gws.types as t


class ElementConfig(t.WithAccess):
    """GWS client UI element configuration"""

    tag: str  #: element tag
    before: str = ''  #: insert before this tag
    after: str = ''  #: insert after this tag


class Config(t.WithAccess):
    """GWS client configuration"""

    options: t.Optional[dict]  #: client options
    elements: t.Optional[t.List[ElementConfig]]  #: client UI elements
    addElements: t.Optional[t.List[ElementConfig]]  #: add elements to the parent element list
    removeElements: t.Optional[t.List[ElementConfig]]  #: remove elements from the parent element list


class ElementProps(t.Data):
    tag: str


class Props(t.Data):
    options: t.Optional[dict]
    elements: t.Optional[t.List[ElementProps]]


class Element(gws.Object):
    @property
    def props(self):
        return ElementProps({
            'tag': self.var('tag'),
        })


#:export IClient
class Object(gws.Object, t.IClient):
    def configure(self):
        super().configure()

        parent_client = self.var('parentClient')

        for c in self._get_elements(parent_client):
            self.create_child(Element, c)

        self.options = self.var('options')

        if not self.options and parent_client:
            self.options = gws.get(parent_client, 'options', {})

    def _get_elements(self, parent_client):
        elements = self.var('elements')
        if elements:
            return elements

        if not parent_client:
            return []

        elements = list(gws.get(parent_client, 'elements', []))

        add = self.var('addElements', default=[])

        for c in add:
            n = _find_element(elements, c.tag)
            if n >= 0:
                elements.pop(n)
            if c.before:
                n = _find_element(elements, c.before)
                if n >= 0:
                    elements.insert(n, c)
            elif c.after:
                n = _find_element(elements, c.after)
                if n >= 0:
                    elements.insert(n + 1, c)
            else:
                elements.append(c)

        remove = self.var('removeElements', default=[])
        remove_tags = [c.tag for c in remove]
        return [e for e in elements if e.tag not in remove_tags]

    @property
    def props(self):
        return Props(options=self.options or {}, elements=self.children)


def _find_element(elements, tag):
    for n, el in enumerate(elements):
        if el.tag == tag:
            return n
    return -1