Modal
See: https://www.carbondesignsystem.com/components/modal/usage/
Modals focus the user’s attention exclusively on one task or piece of information via a window that sits on top of the page content.
Overview
Modals are a variant of dialog used to present critical information or request user input needed to complete a user’s workflow. Modals interrupt a user’s workflow by design. When active, a user is blocked from the on-page content and cannot return to their previous workflow until the modal task is completed or the user dismisses the modal. While effective when used correctly, modals should be used sparingly to limit disruption to the user.
Modal dialogs are commonly used for short and non-frequent tasks, such as editing or management tasks. If a user needs to repeatably preform a task, consider making the task do-able from the main page.
- class carbondesign.tags.modal.Modal(*args, **kwargs)
Modal component.
- WANT_CHILDREN = True
Template Tag needs closing end tag.
- SLOTS = ('label', 'heading', 'footer')
Named children.
- NODE_PROPS = ('id', 'variant', 'has_form', 'size', 'can_scroll')
Extended Template Tag arguments.
- CLASS_AND_PROPS = ('container', 'content', 'close')
Prepare xxx_class and xxx_props values.
- POSSIBLE_VARIANT = ('danger',)
Documentation only.
- POSSIBLE_SIZE = ('xs', 'sm', 'lg')
Documentation only.
- prepare(values, context)
Prepare values for rendering the templates.
- render_default(values, context)
Output html of the component.
- render_slot_label(values, context)
Render html of the slot.
- render_slot_heading(values, context)
Render html of the slot.
Render html of the slot.
- class carbondesign.tags.modal.ModalTrigger(*args, **kwargs)
Modal trigger button.
- NODE_PROPS = ('target', 'disabled', 'variant', 'field', 'small', 'icon_size')
Extended Template Tag arguments.
- prepare(values, context)
Prepare values for rendering the templates.
- after_prepare(values, context)
Simplifying values meant for rendering templates.