Skip to main content

SeamStoryUtils

Utilities for hooking up Seam to UI Labs for UI stories.

Functions​

GetValuesFromControls​

</>
SeamStoryUtils.GetValuesFromControls(
Scope: Scope,--

The Seam scope

Props: {[any]: any}--

The props table passed into the generic story

) → {[string]: Seam.ValueInstance<any>}--

The dictionary of controls mapped to value states

Returns reactive Seam value states based on the generic controls of a UI labs story.

WrappedScopeCleanup​

</>
SeamStoryUtils.WrappedScopeCleanup(
Scope: Scope--

The Seam scope

) → () → nil--

The wrapped cleanup function

Returns a function that cleans up the scope

Show raw api
{
    "functions": [
        {
            "name": "GetValuesFromControls",
            "desc": "Returns reactive Seam value states based on the generic controls of a UI labs story.",
            "params": [
                {
                    "name": "Scope",
                    "desc": "The Seam scope",
                    "lua_type": "Scope"
                },
                {
                    "name": "Props",
                    "desc": "The `props` table passed into the generic story",
                    "lua_type": "{[any] : any}"
                }
            ],
            "returns": [
                {
                    "desc": "The dictionary of controls mapped to value states",
                    "lua_type": "{[string] : Seam.ValueInstance<any>}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/Packages/_Index/miagobble_seam-story-utils@0.1.1/seam-story-utils/init.luau"
            }
        },
        {
            "name": "WrappedScopeCleanup",
            "desc": "Returns a function that cleans up the scope",
            "params": [
                {
                    "name": "Scope",
                    "desc": "The Seam scope",
                    "lua_type": "Scope"
                }
            ],
            "returns": [
                {
                    "desc": "The wrapped cleanup function",
                    "lua_type": "() -> nil"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "src/Packages/_Index/miagobble_seam-story-utils@0.1.1/seam-story-utils/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "SeamStoryUtils",
    "desc": "Utilities for hooking up Seam to UI Labs for UI stories.",
    "source": {
        "line": 6,
        "path": "src/Packages/_Index/miagobble_seam-story-utils@0.1.1/seam-story-utils/init.luau"
    }
}