Skip to content
This repository was archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
evaera committed Jul 5, 2022
1 parent c39a1ce commit 4678dce
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/widgets/heading.lua
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@ local Runtime = require(script.Parent.Parent.Runtime)
local create = require(script.Parent.Parent.create)
local Style = require(script.Parent.Parent.Style)

--[=[
@within Plasma
@function heading
@param text string
@param options? {font: Font}
@tag widgets
Text, but bigger!
]=]
return Runtime.widget(function(text, options)
options = options or {}
local refs = Runtime.useInstance(function(ref)
Expand Down
8 changes: 8 additions & 0 deletions src/widgets/label.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ local create = require(script.Parent.Parent.create)
local Style = require(script.Parent.Parent.Style)
local automaticSize = require(script.Parent.Parent.automaticSize)

--[=[
@within Plasma
@function label
@param text string
@tag widgets
Text.
]=]
return Runtime.widget(function(text)
local refs = Runtime.useInstance(function(ref)
local style = Style.get()
Expand Down
8 changes: 8 additions & 0 deletions src/widgets/space.lua
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
local Runtime = require(script.Parent.Parent.Runtime)
local create = require(script.Parent.Parent.create)

--[=[
@within Plasma
@function space
@param size number
Blank space of a certain size.
]=]
return Runtime.widget(function(size)
local refs = Runtime.useInstance(function(ref)
return create("Frame", {
Expand Down
1 change: 1 addition & 0 deletions src/widgets/table.lua
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ end)
@within Plasma
@function table
@param items {{string}}
@param options {marginTop?: number, selectable?: boolean, font?: Font, headings?: boolean}
@tag widgets
A table widget. Items is a list of rows, with each row being a list of cells.
Expand Down

0 comments on commit 4678dce

Please sign in to comment.