From 4678dceb8151892761417c84a5ee59e5ac80ee73 Mon Sep 17 00:00:00 2001 From: "eryn L. K" Date: Tue, 5 Jul 2022 03:09:18 -0400 Subject: [PATCH] Update docs --- src/widgets/heading.lua | 9 +++++++++ src/widgets/label.lua | 8 ++++++++ src/widgets/space.lua | 8 ++++++++ src/widgets/table.lua | 1 + 4 files changed, 26 insertions(+) diff --git a/src/widgets/heading.lua b/src/widgets/heading.lua index 664000d..9ad381e 100644 --- a/src/widgets/heading.lua +++ b/src/widgets/heading.lua @@ -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) diff --git a/src/widgets/label.lua b/src/widgets/label.lua index fad0ac4..53e3fb2 100644 --- a/src/widgets/label.lua +++ b/src/widgets/label.lua @@ -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() diff --git a/src/widgets/space.lua b/src/widgets/space.lua index 235a790..e2b58e1 100644 --- a/src/widgets/space.lua +++ b/src/widgets/space.lua @@ -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", { diff --git a/src/widgets/table.lua b/src/widgets/table.lua index 6814827..0d6a0cb 100644 --- a/src/widgets/table.lua +++ b/src/widgets/table.lua @@ -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.