Module:UtilsLayout/Tabs: Difference between revisions

Jump to navigation Jump to search

Module:UtilsLayout/Tabs (view source)

Revision as of 23:37, 25 November 2023

492 bytes added ,  25 November 2023
Add ARIA roles so that tabs can at least be manipulated via keyboard when using screen readers. MediaWiki limitations prevent me from adding proper accessibility features, unfortunately.
(refining API)
(Add ARIA roles so that tabs can at least be manipulated via keyboard when using screen readers. MediaWiki limitations prevent me from adding proper accessibility features, unfortunately.)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
local p = {}
local p = {}
local h = {}
local h = {}
local CLASS_TOOLTIP = require("Module:Constants/class/tooltip")


function p.tabs(data, options)
function p.tabs(data, options)
Line 19: Line 21:
local html = mw.html.create("div")
local html = mw.html.create("div")
if tabOptions.position == "top" then
:addClass("zw-tabs")
:addClass(tabOptions.stretch and "zw-tabs--stretch" or nil)
:addClass(tabOptions.columns and "zw-tabs--columns" or nil)
if tabOptions.position == "bottom" then
html:node(tabContents)
:node(tabContainer)
else
html:node(tabContainer)
html:node(tabContainer)
:node(tabContents)
:node(tabContents)
else
html:node(tabContents)
:node(tabContainer)
end
end
return tostring(html)
return tostring(html)
Line 38: Line 43:
:addClass("tabcontainer tabcontainer-"..position)
:addClass("tabcontainer tabcontainer-"..position)
:addClass("tabcontainer--align-x-"..align)
:addClass("tabcontainer--align-x-"..align)
:attr("role", "tablist")
if stretch then
tabContainer:addClass("tabcontainer--stretch")
end
if columns then
tabContainer:addClass("tabcontainer--columns")
end
for i, tabData in ipairs(data) do
for i, tabData in ipairs(data) do
local tab = mw.html.create("span")
local tab = mw.html.create("span")
:addClass("tab")
:addClass("tab")
:addClass("explain")
:addClass(CLASS_TOOLTIP)
:addClass("tab--label-align-y-"..labelAlignVertical)
:addClass("tab--label-align-y-"..labelAlignVertical)
:attr("title", tabData.tooltip)
:attr("title", tabData.tooltip)
:attr("role", "tab")
:attr("tabindex", "0")
:wikitext(tabData.label)
:wikitext(tabData.label)
if i == defaultTab then
if i == defaultTab then
Line 92: Line 93:
local content = mw.html.create("div")
local content = mw.html.create("div")
:addClass("content")
:addClass("content")
:wikitext(tabData.content)
:attr("role", "tabpanel")
:wikitext("\n", tabData.content)
if i == defaultTab then
if i == defaultTab then
content:addClass("content--active")
content:addClass("content--active")
Line 101: Line 103:
end
end


p.Schemas = {
function p.Schemas()
tabs = {
return {
data = {
tabs = {
type = "array",
data = {
required = true,
type = "array",
items = {
required = true,
items = {
type = "record",
properties = {
{
name = "label",
type = "string",
required = true,
desc = "Button text for the tab."
},
{
name = "tooltip",
type = "string",
desc = "Tooltip for the tab button",
},
{
name = "content",
type = "string",
required = true,
desc = "Content for the tab.",
},
}
}
},
options = {
type = "record",
type = "record",
properties = {
properties = {
{
{
name = "label",
name = "default",
type = "number",
default = 1,
desc = "Index of default tab.",
},
{
name = "align",
type = "string",
type = "string",
required = true,
enum = {"left", "center", "right"},
desc = "Button text for the tab."
default = mw.dumpObject("left"),
desc = "Horizontal alignment for tabs and their content.",
},
},
{
{
name = "tooltip",
name = "tabOptions",
type = "string",
type = "record",
desc = "Tooltip for the tab button",
desc = "Display options for the tabs themselves.",
properties = {
{
name = "position",
type = "string",
enum = {"top", "bottom"},
default = mw.dumpObject("top"),
desc = "If <code>top</code> (default), the tabs are placed above their content. If <code>bottom</code>, then the opposite."
},
{
name = "collapse",
type = "boolean",
desc = "If truthy, tabs will not be rendered if there is only one tab. The content of that tab will simply be rendered instead."
},
{
name = "stretch",
type = "boolean",
desc = "If true, then tabs will stretch to fill the available space in their container.",
},
{
name = "columns",
type = "number",
desc = "If specified, the tabs will attempt to arrange themselves in N columns of equal width. This option is not compatible with <code>stretch</code>."
},
},
},
{
name = "labelOptions",
type = "record",
desc = "Display options for the tab labels.",
properties = {
{
name = "alignVertical",
type = "string",
enum = {"center", "bottom"},
default = mw.dumpObject("center"),
desc = "Vertical alignment of the label with respect to its tab. Options are: <code>center</code> (default) and <code>bottom</code>.",
},
},
},
},
{
{
name = "content",
name = "contentOptions",
type = "string",  
type = "record",
required = true,
desc = "Display options for the tab contents.",
desc = "Content for the tab.",
properties = {
{
name = "fixedWidth",
oneOf = {
{ type = "boolean" },
{ type = "number" },
},
desc = "Width for the tab container in <code>px</code>. Or, if set to <code>true</code>, the tab container will  assume the width of the largest tab. By default, the tab container assumes the width of the current tab."
},
{
name = "fixedHeight",
oneOf = {
{ type = "boolean" },
{ type = "number" },
},
desc = "Height for the tab container in <code>px</code>. Or, if set to <code>true</code>, the tab container will  assume the height of the largest tab. By default, the tab container assumes the height of the current tab.",
},
{
name = "alignVertical",
type = "string",
enum = {"top", "center", "bottom"},
default = mw.dumpObject("top"),
desc = "Vertical alignment of tab contents with respect to the tab container. Useful only alonside <code>fixedHeight</code>."
},
},
},
},
}
}
},
options = {
type = "record",
properties = {
{
name = "default",
type = "number",
default = 1,
desc = "Index of default tab.",
},
},
},
}
}
end
function p.Documentation()
return {
tabs = {
params = {"data", "options"},
returns = "HTML markup rendering tabs.",
cases = {
resultOnly = true,
{
{
name = "align",
args = {
type = "string",
{
enum = {"left", "center", "right"},
{
default = mw.dumpObject("left"),
label = "Tab1",
desc = "Horizontal alignment for tabs and their content.",
content = "Content1",
},
{
label = "Tab2",
content = "Content2"
},
},
}
},
},
{
{
name = "tabOptions",
args = {
type = "record",
desc = "Display options for the tabs themselves.",
properties = {
{
{
name = "position",
{
type = "string",
label = "Tab1",
enum = {"top", "bottom"},
content = "Content1",
default = mw.dumpObject("top"),
},
desc = "If <code>top</code> (default), the tabs are placed above their content. If <code>bottom</code>, then the opposite."
{
label = "Tab2",
content = "Content2"
},
},
},
{
{
name = "collapse",
tabOptions = {
type = "boolean",
stretch = true,
desc = "If truthy, tabs will not be rendered if there is only one tab. The content of that tab will simply be rendered instead."
}
},
},
},
},
{
args = {
{
{
name = "stretch",
{
type = "boolean",
label = "Tab1",
desc = "If true, then tabs will stretch to fill the available space in their container.",
tooltip = "This is the first tab.",
content = "Content1"
},
{
label = "Tab2",
tooltip = "This is the second tab.",
content = "Content2"
},
{
label = "Tab3",
tooltip = "This is the third tab.",
content = "Content3"
}
},
},
{
{
name = "columns",
default = 2,
type = "number",
align = "center",
desc = "If specified, the tabs will attempt to arrange themselves in N columns of equal width. This option is not compatible with <code>stretch</code>."
tabOptions = {
position = "bottom",
},
}
}
},
{
desc = "Tabs display even for a single tab unless <code>collapse</code> is set to true.",
args = {
{{ label = "Single Tab", content = "Content" }}
}
},
{
args = {
{{ label = "Single Tab", content = "Content" }},
{
tabOptions = {
collapse = true
}
},
},
},
}
},
},
{
{
name = "labelOptions",
desc = "<code>fixedtWidth</code> and <code>fixedHeight</code> determine how the overall tab container is sized.",
type = "record",
args = {
desc = "Display options for the tab labels.",
properties = {
{
{
name = "alignVertical",
{ label = "Small Tab", content = "meep" },
type = "string",
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeep" },
enum = {"center", "bottom"},
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
default = mw.dumpObject("center"),
desc = "Vertical alignment of the label with respect to its tab. Options are: <code>center</code> (default) and <code>bottom</code>.",
},
},
},
},
},
},
{
{
name = "contentOptions",
args = {
type = "record",
desc = "Display options for the tab contents.",
properties = {
{
{
name = "fixedContentWidth",
{ label = "Small Tab", content = "meep" },
oneOf = {
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ type = "boolean" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
{ type = "number" },
},
desc = "Width for the tab container in <code>px</code>. Or, if set to <code>true</code>, the tab container will  assume the width of the largest tab. By default, the tab container assumes the width of the current tab."
},
},
{
{
name = "fixedContentHeight",
contentOptions = {
oneOf = {
fixedWidth = true,
{ type = "boolean" },
{ type = "number" },
},
},
desc = "Height for the tab container in <code>px</code>. Or, if set to <code>true</code>, the tab container will  assume the height of the largest tab. By default, the tab container assumes the height of the current tab.",
},
},
{
},
name = "alignVertical",
type = "string",
enum = {"top", "center", "bottom"},
default = mw.dumpObject("top"),
desc = "Vertical alignment of tab contents with respect to the tab container. Useful only alonside <code>fixedHeight</code>."
},
},
},
},
},
{
},
args = {
}
}
 
p.Documentation = {
tabs = {
params = {"data", "options"},
returns = "HTML markup rendering tabs.",
cases = {
resultOnly = true,
{
args = {
{
{
{
label = "Tab1",
{ label = "Small Tab", content = "meep" },
content = "Content1",
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
},
{
{
label = "Tab2",
contentOptions = {
content = "Content2"
fixedHeight = true,
},
},
},
},
},
}
},
},
{
{
args = {
args = {
{
{
{
label = "Tab1",
{ label = "Small Tab", content = "meep" },
content = "Content1",
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
},
{
{  
label = "Tab2",
contentOptions = {
content = "Content2"
fixedWidth = true,
fixedHeight = true,
alignVertical = "center",
},
},
},
},
},
{
tabOptions = {
stretch = true,
}
},
},
},
},
{
{
args = {
args = {
{
{
{
label = "Tab1",
{ label = "Small Tab", content = "meep" },
tooltip = "This is the first tab.",
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeep" },
content = "Content1"
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
},
{
contentOptions = {
fixedWidth = 80,
fixedHeight = 80,
alignVertical = "center",
},
},
},
},
{
desc = "When images are used as tab labels, the label alignment options can be useful.",
args = {
{
{
label = "Tab2",
{ label = "[[File:ST Engine Icon.png|link=]]", content = "Engines" },
tooltip = "This is the second tab.",
{ label = "[[File:ST Passenger Car Icon.png|link=]]", content = "Passenger Cars" },
content = "Content2"
},
},
{
{
label = "Tab3",
labelOptions = {
tooltip = "This is the third tab.",
alignVertical = "bottom",
content = "Content3"
},
}
},
{
default = 2,
align = "center",
tabOptions = {
position = "bottom",
},
}
}
},
{
desc = "Tabs display even for a single tab unless <code>collapse</code> is set to true.",
args = {
{{ label = "Single Tab", content = "Content" }}
}
},
{
args = {
{{ label = "Single Tab", content = "Content" }},
{
tabOptions = {
collapse = true
}
},
}
},
{
desc = "<code>fixedContentWidth</code> and <code>fixedContentHeight</code> determine how the overall tab container is sized.",
args = {
{
{ label = "Small Tab", content = "meep" },
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
},
},
{
args = {
{
{ label = "Small Tab", content = "meep" },
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
{
contentOptions = {
fixedWidth = true,
},
},
},
},
{
args = {
{
{ label = "Small Tab", content = "meep" },
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
{
contentOptions = {
fixedHeight = true,
},
},
},
},
{
args = {
{
{ label = "Small Tab", content = "meep" },
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
{
contentOptions = {
fixedWidth = true,
fixedHeight = true,
alignVertical = "center",
},
},
},
},
{
args = {
{
{ label = "Small Tab", content = "meep" },
{ label = "Wide Tab", content = "meeeeeeeeeeeeeeeeeeeeeeeeeeep" },
{ label = "Tall tab", content = "m\ne\ne\ne\ne\np" },
},
{
contentOptions = {
fixedWidth = 80,
fixedHeight = 80,
alignVertical = "center",
},
},
},
},
{
desc = "When images are used as tab labels, the label alignment options can be useful.",
args = {
{
{ label = "[[File:ST Engine Icon.png|link=]]", content = "Engines" },
{ label = "[[File:ST Passenger Car Icon.png|link=]]", content = "Passenger Cars" },
},
{
labelOptions = {
alignVertical = "bottom",
},
},
},
},
Line 391: Line 397:
},
},
},
},
},
}
}
end


return p
return p
Retrieved from "https://zeldawiki.wiki/wiki/Special:MobileDiff/843438...1110963"

Navigation menu