From 8f97c2c52620568d07ad3d3f537a1998299499bc Mon Sep 17 00:00:00 2001 From: Will Hopkins Date: Mon, 1 Apr 2024 11:27:32 -0700 Subject: [PATCH] docs: add type annotations for components --- lua/nui-components/box.lua | 3 +++ lua/nui-components/button.lua | 3 +++ lua/nui-components/checkbox.lua | 3 +++ lua/nui-components/columns.lua | 3 +++ lua/nui-components/component/init.lua | 3 +++ lua/nui-components/form.lua | 3 +++ lua/nui-components/gap.lua | 3 +++ lua/nui-components/paragraph.lua | 3 +++ lua/nui-components/prompt.lua | 5 ++++- lua/nui-components/rows.lua | 3 +++ lua/nui-components/text-input.lua | 3 +++ 11 files changed, 34 insertions(+), 1 deletion(-) diff --git a/lua/nui-components/box.lua b/lua/nui-components/box.lua index 3cfb09e..f3a7e02 100644 --- a/lua/nui-components/box.lua +++ b/lua/nui-components/box.lua @@ -1,6 +1,9 @@ local Component = require("nui-components.component") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Box: NuiComponents.Component +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Box +---@field super NuiComponents.Component local Box = Component:extend("Box") function Box:init(props, popup_options) diff --git a/lua/nui-components/button.lua b/lua/nui-components/button.lua index 61c3ebc..50228b4 100644 --- a/lua/nui-components/button.lua +++ b/lua/nui-components/button.lua @@ -3,6 +3,9 @@ local Paragraph = require("nui-components.paragraph") local event = require("nui.utils.autocmd").event local fn = require("nui-components.utils.fn") +---@class NuiComponents.Button: NuiComponents.Paragraph +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Button +---@field super NuiComponents.Paragraph local Button = Paragraph:extend("Button") function Button:init(props, popup_options) diff --git a/lua/nui-components/checkbox.lua b/lua/nui-components/checkbox.lua index 4e82b10..e8e3497 100644 --- a/lua/nui-components/checkbox.lua +++ b/lua/nui-components/checkbox.lua @@ -3,6 +3,9 @@ local Paragraph = require("nui-components.paragraph") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Checkbox: NuiComponents.Paragraph +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Checkbox +---@field super NuiComponents.Paragraph local Checkbox = Paragraph:extend("Checkbox") function Checkbox:init(props, popup_options) diff --git a/lua/nui-components/columns.lua b/lua/nui-components/columns.lua index 7f4bcbe..f4640cf 100644 --- a/lua/nui-components/columns.lua +++ b/lua/nui-components/columns.lua @@ -1,6 +1,9 @@ local Box = require("nui-components.box") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Columns: NuiComponents.Box +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Columns +---@field super NuiComponents.Box local Columns = Box:extend("Columns") function Columns:init(props, popup_options) diff --git a/lua/nui-components/component/init.lua b/lua/nui-components/component/init.lua index 5f18150..26a3653 100644 --- a/lua/nui-components/component/init.lua +++ b/lua/nui-components/component/init.lua @@ -7,6 +7,9 @@ local Text = require("nui.text") local event = require("nui.utils.autocmd").event local fn = require("nui-components.utils.fn") +---@class NuiComponents.Component: NuiPopup +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Component +---@field super NuiPopup local Component = Popup:extend("Component") function Component:init(props, popup_options) diff --git a/lua/nui-components/form.lua b/lua/nui-components/form.lua index 27168e6..a5a28f9 100644 --- a/lua/nui-components/form.lua +++ b/lua/nui-components/form.lua @@ -1,6 +1,9 @@ local Component = require("nui-components.component") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Form: NuiComponents.Component +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Form +---@field super NuiComponents.Component local Form = Component:extend("Form") function Form:init(props, popup_options) diff --git a/lua/nui-components/gap.lua b/lua/nui-components/gap.lua index 0607e4e..0aac77d 100644 --- a/lua/nui-components/gap.lua +++ b/lua/nui-components/gap.lua @@ -2,6 +2,9 @@ local Component = require("nui-components.component") local Layout = require("nui.layout") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Gap: NuiComponents.Component +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Gap +---@field super NuiComponents.Component local Gap = Component:extend("Gap") function Gap:init(props, popup_options) diff --git a/lua/nui-components/paragraph.lua b/lua/nui-components/paragraph.lua index ce82719..3934392 100644 --- a/lua/nui-components/paragraph.lua +++ b/lua/nui-components/paragraph.lua @@ -4,6 +4,9 @@ local Line = require("nui.line") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Paragraph: NuiComponents.Component +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Paragraph +---@field super NuiComponents.Component local Paragraph = Component:extend("Paragraph") local function get_max_width(lines) diff --git a/lua/nui-components/prompt.lua b/lua/nui-components/prompt.lua index 9497ada..c1c0eb1 100644 --- a/lua/nui-components/prompt.lua +++ b/lua/nui-components/prompt.lua @@ -2,7 +2,10 @@ local Text = require("nui.text") local TextInput = require("nui-components.text-input") local fn = require("nui-components.utils.fn") -local Prompt = TextInput:extend("Gap") +---@class NuiComponents.Prompt: NuiComponents.TextInput +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Prompt +---@field super NuiComponents.TextInput +local Prompt = TextInput:extend("Prompt") function Prompt:init(props, popup_options) Prompt.super.init( diff --git a/lua/nui-components/rows.lua b/lua/nui-components/rows.lua index 2f1264a..7d49aa4 100644 --- a/lua/nui-components/rows.lua +++ b/lua/nui-components/rows.lua @@ -1,6 +1,9 @@ local Box = require("nui-components.box") local fn = require("nui-components.utils.fn") +---@class NuiComponents.Rows: NuiComponents.Box +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.Rows +---@field super NuiComponents.Box local Rows = Box:extend("Rows") function Rows:init(props, popup_options) diff --git a/lua/nui-components/text-input.lua b/lua/nui-components/text-input.lua index a428e83..9228557 100644 --- a/lua/nui-components/text-input.lua +++ b/lua/nui-components/text-input.lua @@ -3,6 +3,9 @@ local Signal = require("nui-components.signal") local event = require("nui.utils.autocmd").event local fn = require("nui-components.utils.fn") +---@class NuiComponents.TextInput: NuiComponents.Component +---@overload fun(_, props: table, popup_options: NuiPopupOptions): NuiComponents.TextInput +---@field super NuiComponents.Component local TextInput = Component:extend("TextInput") function TextInput:init(props, popup_options)