Scope

Declare a scope for this component’s children. Any symbols and scopes declared in the children of this component will be in this scope.

Overload 1

Declare a scope by providing an already created scope. The scope is merely exposed via Scope context.

jsx

import { Scope } from "@alloy-js/core";

<Scope value={OutputScope}>
  {children}
</Scope>

stc

import { Scope } from "@alloy-js/core/stc";

Scope({ value: OutputScope }).children(children)

Props

children	optional Children
value	OutputScope	The scope to use. If not provided, a new scope will be created.

Overload 2

Create a scope by providing a name and optional metadata.

jsx

import { Scope } from "@alloy-js/core";

<Scope
  metadata={Record<string, unknown>}
  name="string"
  ownerSymbol={OutputSymbol}
>
  {children}
</Scope>

stc

import { Scope } from "@alloy-js/core/stc";

Scope({
  metadata: Record<string, unknown>,
  name: string,
  ownerSymbol: OutputSymbol,
}).children(children)

Props

children	optional Children
metadata	optional Record<string, unknown>	Additional metadata for the scope.
name	optional string	The name of this scope.
ownerSymbol	optional OutputSymbol	Create a member scope with the owner symbol providing the in-scope symbols.

Remarks

When called with name (without value), this creates a BasicScope. The parent scope must also be a BasicScope; for custom scope types, create your scope and pass it via the value prop instead.

See also

• Scope context