citry-bootstrap 0.1.0__py3-none-any.whl

citry_bootstrap/__init__.py

@@ -0,0 +1,440 @@
+"""citry-bootstrap"""
+
+from collections.abc import Mapping
+
+from citry import Citry, ComponentLibrary, LibraryComponent, LibraryInstallation
+
+from citry_bootstrap.components.bootstrap5.accordion import (
+    Accordion,
+    AccordionBody,
+    AccordionButton,
+    AccordionHeader,
+    AccordionItem,
+)
+from citry_bootstrap.components.bootstrap5.alert import Alert, AlertHeading, AlertLink
+from citry_bootstrap.components.bootstrap5.badge import Badge
+from citry_bootstrap.components.bootstrap5.breadcrumb import Breadcrumb, BreadcrumbItem
+from citry_bootstrap.components.bootstrap5.button import Button
+from citry_bootstrap.components.bootstrap5.button_group import ButtonGroup, ButtonToolbar
+from citry_bootstrap.components.bootstrap5.card import (
+    Card,
+    CardBody,
+    CardFooter,
+    CardGroup,
+    CardHeader,
+    CardImg,
+    CardImgOverlay,
+    CardLink,
+    CardSubtitle,
+    CardText,
+    CardTitle,
+)
+from citry_bootstrap.components.bootstrap5.carousel import (
+    Carousel,
+    CarouselCaption,
+    CarouselIndicator,
+    CarouselItem,
+    CarouselRenderer,
+)
+from citry_bootstrap.components.bootstrap5.close_button import CloseButton
+from citry_bootstrap.components.bootstrap5.collapse import Collapse, CollapseToggle
+from citry_bootstrap.components.bootstrap5.dropdown import (
+    Dropdown,
+    DropdownDivider,
+    DropdownHeader,
+    DropdownItem,
+    DropdownItemText,
+    DropdownMenu,
+    DropdownToggle,
+)
+from citry_bootstrap.components.bootstrap5.dropdown_button import DropdownButton, SplitButton
+from citry_bootstrap.components.bootstrap5.figure import Figure, FigureCaption, FigureImage
+from citry_bootstrap.components.bootstrap5.form import (
+    Form,
+    FormCheck,
+    FormCheckInput,
+    FormCheckLabel,
+    FormControl,
+    FormFloating,
+    FormGroup,
+    FormLabel,
+    FormSelect,
+    FormText,
+    FormTextarea,
+)
+from citry_bootstrap.components.bootstrap5.form_range import FormRange
+from citry_bootstrap.components.bootstrap5.image import Image
+from citry_bootstrap.components.bootstrap5.input_group import (
+    FloatingLabel,
+    InputGroup,
+    InputGroupCheckbox,
+    InputGroupRadio,
+    InputGroupText,
+)
+from citry_bootstrap.components.bootstrap5.layout import Col, Container, Row
+from citry_bootstrap.components.bootstrap5.list_group import ListGroup, ListGroupItem
+from citry_bootstrap.components.bootstrap5.modal import (
+    Modal,
+    ModalBody,
+    ModalFooter,
+    ModalHeader,
+    ModalTitle,
+    ModalToggle,
+)
+from citry_bootstrap.components.bootstrap5.nav import Nav, NavItem, NavLink
+from citry_bootstrap.components.bootstrap5.nav_dropdown import NavDropdown
+from citry_bootstrap.components.bootstrap5.navbar import (
+    Navbar,
+    NavbarBrand,
+    NavbarCollapse,
+    NavbarNav,
+    NavbarText,
+    NavbarToggler,
+)
+from citry_bootstrap.components.bootstrap5.offcanvas import (
+    Offcanvas,
+    OffcanvasBody,
+    OffcanvasHeader,
+    OffcanvasTitle,
+    OffcanvasToggle,
+)
+from citry_bootstrap.components.bootstrap5.pagination import (
+    PageLink,
+    Pagination,
+    PaginationEllipsis,
+    PaginationFirst,
+    PaginationItem,
+    PaginationLast,
+    PaginationNext,
+    PaginationPrev,
+)
+from citry_bootstrap.components.bootstrap5.placeholder import Placeholder, PlaceholderButton
+from citry_bootstrap.components.bootstrap5.popover import Popover
+from citry_bootstrap.components.bootstrap5.progress import Progress, ProgressBar, ProgressStacked
+from citry_bootstrap.components.bootstrap5.spinner import Spinner
+from citry_bootstrap.components.bootstrap5.stack import Stack
+from citry_bootstrap.components.bootstrap5.table import Table
+from citry_bootstrap.components.bootstrap5.tabs import (
+    Tab,
+    TabContainer,
+    TabContent,
+    TabPane,
+    Tabs,
+    TabsRenderer,
+)
+from citry_bootstrap.components.bootstrap5.toast import (
+    Toast,
+    ToastBody,
+    ToastContainer,
+    ToastHeader,
+)
+from citry_bootstrap.components.bootstrap5.toggle_button import ToggleButton, ToggleButtonGroup
+from citry_bootstrap.components.bootstrap5.tooltip import Tooltip
+from citry_bootstrap.plain_inputs import PlainInputs
+
+#: Every component is published under this prefix; `install(alias=...)` adds more.
+PREFIX = "bs-"
+
+__citry_library__ = ComponentLibrary(
+    name="citry-bootstrap",
+    required_extensions=("plain_inputs",),
+    components=(
+        Accordion,
+        AccordionItem,
+        AccordionButton,
+        AccordionHeader,
+        AccordionBody,
+        Alert,
+        AlertLink,
+        AlertHeading,
+        Badge,
+        Breadcrumb,
+        BreadcrumbItem,
+        Button,
+        ButtonGroup,
+        ButtonToolbar,
+        Card,
+        CardHeader,
+        CardBody,
+        CardFooter,
+        CardTitle,
+        CardSubtitle,
+        CardText,
+        CardLink,
+        CardImg,
+        CardImgOverlay,
+        CardGroup,
+        Carousel,
+        CarouselRenderer,
+        CarouselItem,
+        CarouselCaption,
+        CarouselIndicator,
+        CloseButton,
+        Collapse,
+        CollapseToggle,
+        Dropdown,
+        DropdownToggle,
+        DropdownMenu,
+        DropdownItem,
+        DropdownDivider,
+        DropdownHeader,
+        DropdownItemText,
+        DropdownButton,
+        SplitButton,
+        Figure,
+        FigureImage,
+        FigureCaption,
+        Form,
+        FormGroup,
+        FormLabel,
+        FormControl,
+        FormTextarea,
+        FormSelect,
+        FormCheckInput,
+        FormCheckLabel,
+        FormCheck,
+        FormText,
+        FormFloating,
+        FormRange,
+        Image,
+        InputGroup,
+        InputGroupText,
+        InputGroupRadio,
+        InputGroupCheckbox,
+        FloatingLabel,
+        Container,
+        Row,
+        Col,
+        ListGroup,
+        ListGroupItem,
+        Modal,
+        ModalHeader,
+        ModalBody,
+        ModalFooter,
+        ModalTitle,
+        ModalToggle,
+        Nav,
+        NavItem,
+        NavLink,
+        NavDropdown,
+        Navbar,
+        NavbarBrand,
+        NavbarToggler,
+        NavbarCollapse,
+        NavbarNav,
+        NavbarText,
+        Offcanvas,
+        OffcanvasHeader,
+        OffcanvasBody,
+        OffcanvasTitle,
+        OffcanvasToggle,
+        Pagination,
+        PaginationItem,
+        PageLink,
+        PaginationFirst,
+        PaginationPrev,
+        PaginationNext,
+        PaginationLast,
+        PaginationEllipsis,
+        Placeholder,
+        PlaceholderButton,
+        Popover,
+        Progress,
+        ProgressStacked,
+        ProgressBar,
+        Spinner,
+        Stack,
+        Table,
+        TabContainer,
+        TabContent,
+        TabPane,
+        TabsRenderer,
+        Tabs,
+        Tab,
+        ToastContainer,
+        Toast,
+        ToastHeader,
+        ToastBody,
+        ToggleButtonGroup,
+        ToggleButton,
+        Tooltip,
+    ),
+)
+
+
+def _republished(
+    component: type[LibraryComponent], prefix: str, override: "Mapping[type, type]"
+) -> type[LibraryComponent]:
+    """One component under `prefix`, with its sibling references following."""
+    definition = override.get(component, component)
+    name = prefix + component.name.removeprefix(PREFIX)
+    changes: dict[str, object] = {"name": name}
+    template = getattr(definition, "template", None)
+    if isinstance(template, str) and f"<c-{PREFIX}" in template:
+        changes["template"] = template.replace(f"<c-{PREFIX}", f"<c-{prefix}").replace(
+            f"</c-{PREFIX}", f"</c-{prefix}"
+        )
+    return type(definition.__name__, (definition,), changes)
+
+
+def library(
+    *, prefix: str = PREFIX, override: "Mapping[type, type] | None" = None
+) -> ComponentLibrary:
+    """The manifest, published under `prefix`, with components replaced.
+
+    A component's template names its siblings, so the prefix is rewritten in
+    both places at once. Nothing is published under the old prefix afterwards.
+    """
+    override = dict(override or {})
+    unknown = set(override) - set(__citry_library__.components)
+    if unknown:
+        names = ", ".join(sorted(c.__name__ for c in unknown))
+        msg = f"not part of this library: {names}"
+        raise ValueError(msg)
+    if prefix == PREFIX and not override:
+        return __citry_library__
+    return ComponentLibrary(
+        name="citry-bootstrap",
+        required_extensions=("plain_inputs",),
+        components=tuple(_republished(c, prefix, override) for c in __citry_library__.components),
+    )
+
+
+def install(
+    app: Citry, *, prefix: str = PREFIX, override: "Mapping[type, type] | None" = None
+) -> LibraryInstallation:
+    """Register the library.
+
+    Components are published as `<c-bs-button>`. `prefix` changes that for all
+    of them - `prefix=""` gives `<c-button>` - and `override` swaps one for your
+    own subclass, which every sibling then renders too:
+
+        install(app, prefix="ui-", override={CardBody: MyCardBody})
+    """
+    return app.register_library(library(prefix=prefix, override=override))
+
+
+__all__ = [
+    "install",
+    "__citry_library__",
+    "PlainInputs",
+    "Accordion",
+    "AccordionItem",
+    "AccordionButton",
+    "AccordionHeader",
+    "AccordionBody",
+    "Alert",
+    "AlertLink",
+    "AlertHeading",
+    "Badge",
+    "Breadcrumb",
+    "BreadcrumbItem",
+    "Button",
+    "ButtonGroup",
+    "ButtonToolbar",
+    "Card",
+    "CardHeader",
+    "CardBody",
+    "CardFooter",
+    "CardTitle",
+    "CardSubtitle",
+    "CardText",
+    "CardLink",
+    "CardImg",
+    "CardImgOverlay",
+    "CardGroup",
+    "Carousel",
+    "CarouselRenderer",
+    "CarouselItem",
+    "CarouselCaption",
+    "CarouselIndicator",
+    "CloseButton",
+    "Collapse",
+    "CollapseToggle",
+    "Dropdown",
+    "DropdownToggle",
+    "DropdownMenu",
+    "DropdownItem",
+    "DropdownDivider",
+    "DropdownHeader",
+    "DropdownItemText",
+    "DropdownButton",
+    "SplitButton",
+    "Figure",
+    "FigureImage",
+    "FigureCaption",
+    "Form",
+    "FormGroup",
+    "FormLabel",
+    "FormControl",
+    "FormTextarea",
+    "FormSelect",
+    "FormCheckInput",
+    "FormCheckLabel",
+    "FormCheck",
+    "FormText",
+    "FormFloating",
+    "FormRange",
+    "Image",
+    "InputGroup",
+    "InputGroupText",
+    "InputGroupRadio",
+    "InputGroupCheckbox",
+    "FloatingLabel",
+    "Container",
+    "Row",
+    "Col",
+    "ListGroup",
+    "ListGroupItem",
+    "Modal",
+    "ModalHeader",
+    "ModalBody",
+    "ModalFooter",
+    "ModalTitle",
+    "ModalToggle",
+    "Nav",
+    "NavItem",
+    "NavLink",
+    "NavDropdown",
+    "Navbar",
+    "NavbarBrand",
+    "NavbarToggler",
+    "NavbarCollapse",
+    "NavbarNav",
+    "NavbarText",
+    "Offcanvas",
+    "OffcanvasHeader",
+    "OffcanvasBody",
+    "OffcanvasTitle",
+    "OffcanvasToggle",
+    "Pagination",
+    "PaginationItem",
+    "PageLink",
+    "PaginationFirst",
+    "PaginationPrev",
+    "PaginationNext",
+    "PaginationLast",
+    "PaginationEllipsis",
+    "Placeholder",
+    "PlaceholderButton",
+    "Popover",
+    "Progress",
+    "ProgressStacked",
+    "ProgressBar",
+    "Spinner",
+    "Stack",
+    "Table",
+    "TabContainer",
+    "TabContent",
+    "TabPane",
+    "TabsRenderer",
+    "Tabs",
+    "Tab",
+    "ToastContainer",
+    "Toast",
+    "ToastHeader",
+    "ToastBody",
+    "ToggleButtonGroup",
+    "ToggleButton",
+    "Tooltip",
+]

citry_bootstrap/components/bootstrap5/__init__.py

@@ -0,0 +1,82 @@
+from .accordion import Accordion, AccordionBody, AccordionButton, AccordionHeader, AccordionItem
+from .alert import Alert, AlertHeading, AlertLink
+from .badge import Badge
+from .breadcrumb import Breadcrumb, BreadcrumbItem
+from .button import Button
+from .button_group import ButtonGroup, ButtonToolbar
+from .card import (
+    Card,
+    CardBody,
+    CardFooter,
+    CardGroup,
+    CardHeader,
+    CardImg,
+    CardImgOverlay,
+    CardLink,
+    CardSubtitle,
+    CardText,
+    CardTitle,
+)
+from .carousel import Carousel, CarouselCaption, CarouselIndicator, CarouselItem, CarouselRenderer
+from .close_button import CloseButton
+from .collapse import Collapse, CollapseToggle
+from .dropdown import (
+    Dropdown,
+    DropdownDivider,
+    DropdownHeader,
+    DropdownItem,
+    DropdownItemText,
+    DropdownMenu,
+    DropdownToggle,
+)
+from .dropdown_button import DropdownButton, SplitButton
+from .figure import Figure, FigureCaption, FigureImage
+from .form import (
+    Form,
+    FormCheck,
+    FormCheckInput,
+    FormCheckLabel,
+    FormControl,
+    FormFloating,
+    FormGroup,
+    FormLabel,
+    FormSelect,
+    FormText,
+    FormTextarea,
+)
+from .form_range import FormRange
+from .image import Image
+from .input_group import (
+    FloatingLabel,
+    InputGroup,
+    InputGroupCheckbox,
+    InputGroupRadio,
+    InputGroupText,
+)
+from .layout import Col, Container, Row
+from .list_group import ListGroup, ListGroupItem
+from .modal import Modal, ModalBody, ModalFooter, ModalHeader, ModalTitle, ModalToggle
+from .nav import Nav, NavItem, NavLink
+from .nav_dropdown import NavDropdown
+from .navbar import Navbar, NavbarBrand, NavbarCollapse, NavbarNav, NavbarText, NavbarToggler
+from .offcanvas import Offcanvas, OffcanvasBody, OffcanvasHeader, OffcanvasTitle, OffcanvasToggle
+from .pagination import (
+    PageLink,
+    Pagination,
+    PaginationEllipsis,
+    PaginationFirst,
+    PaginationItem,
+    PaginationLast,
+    PaginationNext,
+    PaginationPrev,
+)
+from .placeholder import Placeholder, PlaceholderButton
+from .popover import Popover
+from .progress import Progress, ProgressBar, ProgressStacked
+from .spinner import Spinner
+from .stack import Stack
+from .table import Table
+from .tabs import Tab, TabContainer, TabContent, TabPane, Tabs, TabsRenderer
+from .toast import Toast, ToastBody, ToastContainer, ToastHeader
+from .toggle_button import ToggleButton, ToggleButtonGroup
+from .tooltip import Tooltip

citry_bootstrap/components/bootstrap5/accordion.py

@@ -0,0 +1,197 @@
+from citry import LibraryComponent, SlotInput, merge_attrs
+
+
+class Accordion(LibraryComponent):
+    name = "bs-accordion"
+
+    class Kwargs:
+        flush: bool = False
+        always_open: bool = False
+        attrs: dict | None = None
+
+    class Slots:
+        default: SlotInput
+
+    def template_data(self, kwargs: Kwargs, slots: Slots):
+        accordion_id = (kwargs.attrs or {}).get("id") or f"accordion-{self.id}"
+
+        css_classes = ["accordion"]
+        if kwargs.flush:
+            css_classes.append("accordion-flush")
+
+        data = {
+            "accordion_id": accordion_id,
+            "css_class": " ".join(css_classes),
+            "always_open": kwargs.always_open,
+            "attrs": kwargs.attrs,
+        }
+        data["div_attrs"] = merge_attrs(
+            {"id": data["accordion_id"]}, (data["attrs"] or {}), {"class": data["css_class"]}
+        )
+        return data
+
+    template = """
+        <c-provide key="accordion" c-accordion_id="accordion_id" c-always_open="always_open">
+        <div c-bind="div_attrs">
+        <c-slot />
+        </div>
+        </c-provide>
+    """
+
+
+class AccordionItem(LibraryComponent):
+    name = "bs-accordion-item"
+
+    class Kwargs:
+        default_open: bool = False
+        attrs: dict | None = None
+
+    class Slots:
+        default: SlotInput
+
+    def template_data(self, kwargs: Kwargs, slots: Slots):
+        accordion = self.inject("accordion")
+
+        item_id = (kwargs.attrs or {}).get("id") or f"accordion-item-{self.id}"
+        heading_id = f"{item_id}-heading"
+        collapse_id = f"{item_id}-collapse"
+        data_bs_parent = f"#{accordion.accordion_id}"
+
+        data = {
+            "heading_id": heading_id,
+            "collapse_id": collapse_id,
+            "is_open": kwargs.default_open,
+            "data_bs_parent": data_bs_parent,
+            "always_open": accordion.always_open,
+            "attrs": kwargs.attrs,
+        }
+        data["div_attrs"] = merge_attrs((data["attrs"] or {}), {"class": "accordion-item"})
+        return data
+
+    template = """
+        <c-provide key="accordion_item" c-heading_id="heading_id" c-collapse_id="collapse_id" c-is_open="is_open" c-data_bs_parent="data_bs_parent" c-always_open="always_open">
+        <div c-bind="div_attrs">
+        <c-slot />
+        </div>
+        </c-provide>
+    """
+
+
+class AccordionButton(LibraryComponent):
+    name = "bs-accordion-button"
+
+    class Kwargs:
+        disabled: bool = False
+        attrs: dict | None = None
+
+    class Slots:
+        default: SlotInput
+
+    def template_data(self, kwargs: Kwargs, slots: Slots):
+        accordion_item = self.inject("accordion_item")
+
+        classes = ["accordion-button"]
+        if not accordion_item.is_open:
+            classes.append("collapsed")
+
+        data = {
+            "button_classes": " ".join(classes),
+            "collapse_id": accordion_item.collapse_id,
+            "aria_expanded": "true" if accordion_item.is_open else "false",
+            "disabled": kwargs.disabled,
+            "attrs": kwargs.attrs,
+        }
+        data["button_attrs"] = merge_attrs(
+            {
+                "aria-expanded": data["aria_expanded"],
+                "aria-controls": data["collapse_id"],
+                "disabled": data["disabled"],
+            },
+            (data["attrs"] or {}),
+            {
+                "class": data["button_classes"],
+                "type": "button",
+                "data-bs-toggle": "collapse",
+                "data-bs-target": f"#{data['collapse_id']}",
+            },
+        )
+        return data
+
+    template = """
+        <button c-bind="button_attrs">
+        <c-slot />
+        </button>
+    """
+
+
+class AccordionHeader(LibraryComponent):
+    name = "bs-accordion-header"
+
+    class Kwargs:
+        disabled: bool = False
+        attrs: dict | None = None
+
+    class Slots:
+        default: SlotInput
+
+    def template_data(self, kwargs: Kwargs, slots: Slots):
+        accordion_item = self.inject("accordion_item")
+
+        data = {
+            "heading_id": accordion_item.heading_id,
+            "disabled": kwargs.disabled,
+            "attrs": kwargs.attrs,
+        }
+        data["h2_attrs"] = merge_attrs(
+            {"id": data["heading_id"]}, (data["attrs"] or {}), {"class": "accordion-header"}
+        )
+        return data
+
+    template = """
+        <h2 c-bind="h2_attrs">
+        <c-bs-accordion-button c-disabled="disabled">
+        <c-slot />
+        </c-bs-accordion-button>
+        </h2>
+    """
+
+
+class AccordionBody(LibraryComponent):
+    name = "bs-accordion-body"
+
+    class Kwargs:
+        attrs: dict | None = None
+
+    class Slots:
+        default: SlotInput
+
+    def template_data(self, kwargs: Kwargs, slots: Slots):
+        accordion_item = self.inject("accordion_item")
+
+        collapse_classes = ["accordion-collapse", "collapse"]
+        if accordion_item.is_open:
+            collapse_classes.append("show")
+
+        data = {
+            "heading_id": accordion_item.heading_id,
+            "collapse_id": accordion_item.collapse_id,
+            "collapse_classes": " ".join(collapse_classes),
+            "data_bs_parent": accordion_item.data_bs_parent,
+            "always_open": accordion_item.always_open,
+            "attrs": kwargs.attrs,
+        }
+        data["div_attrs"] = merge_attrs(
+            {"aria-labelledby": data["heading_id"]},
+            {"id": data["collapse_id"], "class": data["collapse_classes"]},
+            ({"data-bs-parent": data["data_bs_parent"]} if (not data["always_open"]) else {}),
+        )
+        data["div_attrs2"] = merge_attrs((data["attrs"] or {}), {"class": "accordion-body"})
+        return data
+
+    template = """
+        <div c-bind="div_attrs" >
+        <div c-bind="div_attrs2">
+        <c-slot />
+        </div>
+        </div>
+    """