From 003d8c41feee0576336829e7df79b75306ba631a Mon Sep 17 00:00:00 2001 From: NoryiE Date: Tue, 4 Nov 2025 21:41:17 +0000 Subject: [PATCH] deploy: 2ca7ad1e4c0f0181383ae9bd888811157acc9312 --- docs/references/elements/BaseElement.md | 13 +++++++++++++ docs/references/plugins/responsive.md | 18 ++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/references/plugins/responsive.md diff --git a/docs/references/elements/BaseElement.md b/docs/references/elements/BaseElement.md index 73ce16d..7631f7e 100644 --- a/docs/references/elements/BaseElement.md +++ b/docs/references/elements/BaseElement.md @@ -30,6 +30,7 @@ Extends: `PropertySystem` |[BaseElement:getCurrentState](#baseelement-getcurrentstate)|string|nil|Gets current primary state| |[BaseElement:getActiveStates](#baseelement-getactivestates)|table|Gets all active states| |[BaseElement:updateConditionalStates](#baseelement-updateconditionalstates)|BaseElement|Updates conditional states| +|[BaseElement:registerResponsiveState](#baseelement-registerresponsivestate-statename-condition-options)|BaseElement|Registers a state that responds to parent dimensions| |[BaseElement:unregisterState](#baseelement-unregisterstate-statename)|BaseElement|Removes state definition| |[BaseElement:fireEvent](#baseelement-fireevent-event-any)|table|Triggers event callbacks with provided arguments| |[BaseElement:onChange](#baseelement-onchange-property-callback)|table|Watches property changes with callback notification| @@ -151,6 +152,18 @@ Updates all states that have auto-conditions ### Returns * `BaseElement` self +## BaseElement:registerResponsiveState(stateName, condition, options?) + +Registers a responsive state that reacts to parent size changes + +### Parameters +* `stateName` `string` The name of the state +* `condition` `string|function` Condition as string expression or function: function(element) return boolean end +* `options` *(optional)* `table|number` Options table with 'priority' and 'observe', or just priority number + +### Returns +* `BaseElement` self + ## BaseElement:unregisterState(stateName) Removes a state from the registry diff --git a/docs/references/plugins/responsive.md b/docs/references/plugins/responsive.md new file mode 100644 index 0000000..963c1ce --- /dev/null +++ b/docs/references/plugins/responsive.md @@ -0,0 +1,18 @@ +# BaseElement +_This is the responsive plugin. It provides a fluent builder API for creating responsive states with an intuitive when/apply/otherwise syntax._ + +## Functions + +|Method|Returns|Description| +|---|---|---| +|[BaseElement:responsive](#baseelement-responsive-self)|ResponsiveBuilder|Creates a responsive state builder| + +## BaseElement:responsive(self) + +Creates a responsive builder for defining responsive states + +### Parameters +* `self` `BaseElement` The element to create the builder for + +### Returns +* `ResponsiveBuilder` `builder` The responsive builder instance