hakowork/vide
3
0
Fork 0
mirror of https://github.com/centau/vide.git synced 2026-08-20 14:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add create(a, { props }) syntax (#42)

Browse source 
* Add new create syntax

* Add new create syntax to changelog

* Fix new create syntax test
This commit is contained in:
11poe 2024-11-16 21:20:49 +01:00 • committed by GitHub
parent 8799988851
commit 44fe65ee5e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 70 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CHANGELOG.md
View file

@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
--------------------------------------------------------------------------------
## [Unreleased]
### Added
- `create("ClassName", { props })` and `create(Instance, { props })` syntax.
--------------------------------------------------------------------------------
## [0.3.1] - 2024-10-09
### Added

83
src/create.luau
View file

@ -40,44 +40,53 @@ local function clone_instance(instance: Instance)
end
end
local function create(class_or_instance: string|Instance): (Props) -> Instance
if type(class_or_instance) == "string" then
return create_instance(class_or_instance)
elseif typeof(class_or_instance) == "Instance" then
return clone_instance(class_or_instance)
else
throw("bad argument #1, expected string or instance, got " .. typeof(class_or_instance))
return nil :: never
end
local function create(class_or_instance: string | Instance, props: Props?): ((Props) -> Instance) | Instance
local result: (Props) -> Instance
if type(class_or_instance) == "string" then
result = create_instance(class_or_instance)
elseif typeof(class_or_instance) == "Instance" then
result = clone_instance(class_or_instance)
else
throw("bad argument #1, expected string or instance, got " .. typeof(class_or_instance))
return nil :: never
end
if props then
return result(props)
end
return result
end
type Props = { [any]: any }
type Create<Name, Instance> = ((Name, Props) -> Instance) & ((Name) -> (Props) -> Instance)
return (create :: any) ::
( <T>(T & Instance) -> (Props) -> T ) &
( ("Folder") -> (Props) -> Folder ) &
( ("BillboardGui") -> (Props) -> BillboardGui ) &
( ("CanvasGroup") -> (Props) -> CanvasGroup ) &
( ("Frame") -> (Props) -> Frame ) &
( ("ImageButton") -> (Props) -> ImageButton ) &
( ("ImageLabel") -> (Props) -> ImageLabel ) &
( ("ScreenGui") -> (Props) -> ScreenGui ) &
( ("ScrollingFrame") -> (Props) -> ScrollingFrame ) &
( ("SurfaceGui") -> (Props) -> SurfaceGui ) &
( ("TextBox") -> (Props) -> TextBox ) &
( ("TextButton") -> (Props) -> TextButton ) &
( ("TextLabel") -> (Props) -> TextLabel ) &
( ("UIAspectRatioConstraint") -> (Props) -> UIAspectRatioConstraint ) &
( ("UICorner") -> (Props) -> UICorner ) &
( ("UIGradient") -> (Props) -> UIGradient ) &
( ("UIGridLayout") -> (Props) -> UIGridLayout ) &
( ("UIListLayout") -> (Props) -> UIListLayout ) &
( ("UIPadding") -> (Props) -> UIPadding ) &
( ("UIPageLayout") -> (Props) -> UIPageLayout ) &
( ("UIScale") -> (Props) -> UIScale ) &
( ("UISizeConstraint") -> (Props) -> UISizeConstraint ) &
( ("UIStroke") -> (Props) -> UIStroke ) &
( ("UITableLayout") -> (Props) -> UITableLayout ) &
( ("UITextSizeConstraint") -> (Props) -> UITextSizeConstraint ) &
( ("VideoFrame") -> (Props) -> VideoFrame ) &
( ("ViewportFrame") -> (Props) -> ViewportFrame ) &
( (string) -> (Props) -> Instance )
& ( <T>(T & Instance) -> (Props) -> T )
& ( <T>(T & Instance, Props) -> T )
& Create<"Folder", Folder>
& Create<"BillboardGui", BillboardGui>
& Create<"CanvasGroup", CanvasGroup>
& Create<"Frame", Frame>
& Create<"ImageButton", ImageButton>
& Create<"ImageLabel", ImageLabel>
& Create<"ScreenGui", ScreenGui>
& Create<"ScrollingFrame", ScrollingFrame>
& Create<"SurfaceGui", SurfaceGui>
& Create<"TextBox", TextBox>
& Create<"TextButton", TextButton>
& Create<"TextLabel", TextLabel>
& Create<"UIAspectRatioConstraint", UIAspectRatioConstraint>
& Create<"UICorner", UICorner>
& Create<"UIGradient", UIGradient>
& Create<"UIGridLayout", UIGridLayout>
& Create<"UIListLayout", UIListLayout>
& Create<"UIPadding", UIPadding>
& Create<"UIPageLayout", UIPageLayout>
& Create<"UIScale", UIScale>
& Create<"UISizeConstraint", UISizeConstraint>
& Create<"UIStroke", UIStroke>
& Create<"UITableLayout", UITableLayout>
& Create<"UITextSizeConstraint", UITextSizeConstraint>
& Create<"VideoFrame", VideoFrame>
& Create<"ViewportFrame", ViewportFrame>
& Create<string, Instance>

13
test/tests.luau
View file

@ -721,6 +721,19 @@ TEST("create()", wrap_root(function()
local source = vide.source
local cleanup = vide.cleanup
do CASE "create(\"ClassName\", props) syntax"
local frame = create("Frame", { BackgroundTransparency = 0.5, Name = "Foo" })
CHECK(frame.BackgroundTransparency == 0.5)
CHECK(frame.Name == "Foo")
end
do CASE "create(Instance, props) syntax"
local frame0 = create("Frame", { BackgroundTransparency = 0.5, Name = "Foo" })
local frame = create(frame0, { BackgroundTransparency = 1 })
CHECK(frame.BackgroundTransparency == 1)
CHECK(frame.Name == "Foo")
end
do CASE "apply default properties"
local defaults = require "../src/defaults"
local frame = create "Frame" {} :: Instance & { BorderSizePixel: any, BorderColor3: any }