Module:Clickable button 2: Difference between revisions
Jump to navigation
Jump to search
en>Mr. Stradivarius m Protected Module:Clickable button 2: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite)) |
m 15 revisions imported |
||
(7 intermediate revisions by 5 users not shown) | |||
Line 13: | Line 13: | ||
function p.luaMain(args) | function p.luaMain(args) | ||
-- If first arg or a url is not provided, | |||
-- but we have a second arg, make a button. | |||
-- Otherwise, return nothing. | |||
if not args[1] and not args.url then | if not args[1] and not args.url then | ||
return '' | if args[2] then | ||
p.nolink = true | |||
else | |||
return '' | |||
end | |||
end | end | ||
local data = p.makeLinkData(args) | local data = p.makeLinkData(args) | ||
local link = p.renderLink(data) | local link = p.renderLink(data) | ||
Line 24: | Line 32: | ||
function p.makeLinkData(args) | function p.makeLinkData(args) | ||
local data = {} | local data = {} | ||
-- Get the link and display values, | |||
-- and find whether we are outputting | |||
-- a wikilink or a URL. | |||
if args.url then | |||
data.isUrl = true | |||
data.link = args.url | |||
if args[1] then | |||
data.display = args[1] | |||
else if args[2] then | |||
data.display = args[2] | |||
else | |||
data.display = args.url | |||
p.urlisdisplay = true | |||
end | |||
end | |||
else | |||
data.isUrl = false | |||
p.urlisdisplay = false | |||
data.link = args[1] | |||
if args[2] then | |||
data.display = args[2] | |||
else | |||
data.display = args[1] | |||
end | |||
end | |||
if yesno(args.link) == false then | |||
p.nolink = true | |||
end | |||
-- Colours | |||
-- For the merge with {{clickable button}} | |||
local colour = args.color and args.color:lower() | |||
-- Classes | -- Classes | ||
Line 40: | Line 82: | ||
table.insert(data.classes, 'mw-ui-button') | table.insert(data.classes, 'mw-ui-button') | ||
end | end | ||
--If class is unset, | |||
--then let color determine class | |||
if not class then | |||
if colour == 'blue' then | |||
class = 'mw-ui-progressive' | |||
else if colour == 'red' then | |||
class = 'mw-ui-destructive' | |||
else if colour == 'green' then | |||
class = 'mw-ui-constructive' | |||
end | |||
end | |||
end | |||
end | |||
if class then | if class then | ||
table.insert(data.classes, class) | table.insert(data.classes, class) | ||
Line 46: | Line 103: | ||
-- Styles | -- Styles | ||
do | do | ||
local currentTitle = mw.title.getCurrentTitle() | --[[ | ||
-- Check whether we are on the same page as we have specified in | |||
if success and mw.title.equals(currentTitle, linkTitle) then | -- args[1], but not if we are using a URL link, as then args[1] is only | ||
-- a display value. If we are currently on the page specified in | |||
-- args[1] make the button colour darker so that it stands out from | |||
-- other buttons on the page. | |||
--]] | |||
local success, linkTitle, currentTitle | |||
if not data.isUrl then | |||
currentTitle = mw.title.getCurrentTitle() | |||
success, linkTitle = pcall(mw.title.new, args[1]) | |||
elseif p.urlisdisplay then | |||
currentTitle = mw.title.getCurrentTitle() | |||
end | |||
if success | |||
and linkTitle | |||
and mw.title.equals(currentTitle, linkTitle) | |||
and not p.urlisdisplay | |||
then | |||
if class == 'ui-button-blue' | if class == 'ui-button-blue' | ||
or class == 'mw-ui-progressive' | or class == 'mw-ui-progressive' | ||
or class == 'mw-ui-constructive' | |||
then | then | ||
data.backgroundColor = '#2962CB' | data.backgroundColor = '#2962CB' | ||
elseif class == 'ui-button-green' | data.color = '#fff' | ||
elseif class == 'ui-button-green' then | |||
data.backgroundColor = '#008B6D' | data.backgroundColor = '#008B6D' | ||
elseif class == 'ui-button-red' | elseif class == 'ui-button-red' or class == 'mw-ui-destructive' then | ||
data.backgroundColor = '#A6170F' | data.backgroundColor = '#A6170F' | ||
else | else | ||
data.backgroundColor = '#CCC' | data.backgroundColor = '#CCC' | ||
data.color = '#666' | data.color = '#666' | ||
end | |||
else | |||
if p.urlisdisplay | |||
then | |||
data.dummyLink = tostring(currentTitle) | |||
end | end | ||
end | end | ||
-- Add user-specified styles. | |||
data.style = args.style | data.style = args.style | ||
end | end | ||
Line 101: | Line 158: | ||
end | end | ||
displaySpan | displaySpan | ||
:css{ | :css{ | ||
['background-color'] = data.backgroundColor, | ['background-color'] = data.backgroundColor, | ||
Line 115: | Line 170: | ||
-- Render the link | -- Render the link | ||
local link | local link | ||
if data.isUrl then | if p.nolink then | ||
if p.urlisdisplay then | |||
link = string.format('[[%s|%s]]', data.dummyLink, display) | |||
else | |||
link = string.format('%s', display) | |||
end | |||
else if data.isUrl then | |||
link = string.format('[%s %s]', data.link, display) | |||
else | |||
link = string.format('[[%s|%s]]', data.link, display) | |||
end | |||
end | end | ||
return string.format('<span class="plainlinks">%s</span>', link) | return string.format('<span class="plainlinks clickbutton">%s</span>', link) | ||
end | end | ||
Latest revision as of 19:32, 8 June 2022
Documentation for this module may be created at Module:Clickable button 2/doc
-- This module implements {{clickable button 2}}.
local yesno = require('Module:Yesno')
local p = {}
function p.main(frame)
local args = require('Module:Arguments').getArgs(frame, {
wrappers = 'Template:Clickable button 2'
})
return p.luaMain(args)
end
function p.luaMain(args)
-- If first arg or a url is not provided,
-- but we have a second arg, make a button.
-- Otherwise, return nothing.
if not args[1] and not args.url then
if args[2] then
p.nolink = true
else
return ''
end
end
local data = p.makeLinkData(args)
local link = p.renderLink(data)
local trackingCategories = p.renderTrackingCategories(args)
return link .. trackingCategories
end
function p.makeLinkData(args)
local data = {}
-- Get the link and display values,
-- and find whether we are outputting
-- a wikilink or a URL.
if args.url then
data.isUrl = true
data.link = args.url
if args[1] then
data.display = args[1]
else if args[2] then
data.display = args[2]
else
data.display = args.url
p.urlisdisplay = true
end
end
else
data.isUrl = false
p.urlisdisplay = false
data.link = args[1]
if args[2] then
data.display = args[2]
else
data.display = args[1]
end
end
if yesno(args.link) == false then
p.nolink = true
end
-- Colours
-- For the merge with {{clickable button}}
local colour = args.color and args.color:lower()
-- Classes
local class = args.class and args.class:lower()
data.classes = {}
if class == 'ui-button-green'
or class == 'ui-button-blue'
or class == 'ui-button-red'
then
table.insert(
data.classes,
'submit ui-button ui-widget ui-state-default ui-corner-all'
.. ' ui-button-text-only ui-button-text'
)
else
table.insert(data.classes, 'mw-ui-button')
end
--If class is unset,
--then let color determine class
if not class then
if colour == 'blue' then
class = 'mw-ui-progressive'
else if colour == 'red' then
class = 'mw-ui-destructive'
else if colour == 'green' then
class = 'mw-ui-constructive'
end
end
end
end
if class then
table.insert(data.classes, class)
end
-- Styles
do
--[[
-- Check whether we are on the same page as we have specified in
-- args[1], but not if we are using a URL link, as then args[1] is only
-- a display value. If we are currently on the page specified in
-- args[1] make the button colour darker so that it stands out from
-- other buttons on the page.
--]]
local success, linkTitle, currentTitle
if not data.isUrl then
currentTitle = mw.title.getCurrentTitle()
success, linkTitle = pcall(mw.title.new, args[1])
elseif p.urlisdisplay then
currentTitle = mw.title.getCurrentTitle()
end
if success
and linkTitle
and mw.title.equals(currentTitle, linkTitle)
and not p.urlisdisplay
then
if class == 'ui-button-blue'
or class == 'mw-ui-progressive'
or class == 'mw-ui-constructive'
then
data.backgroundColor = '#2962CB'
data.color = '#fff'
elseif class == 'ui-button-green' then
data.backgroundColor = '#008B6D'
elseif class == 'ui-button-red' or class == 'mw-ui-destructive' then
data.backgroundColor = '#A6170F'
else
data.backgroundColor = '#CCC'
data.color = '#666'
end
else
if p.urlisdisplay
then
data.dummyLink = tostring(currentTitle)
end
end
-- Add user-specified styles.
data.style = args.style
end
return data
end
function p.renderLink(data)
-- Render the display span tag.
local display
do
local displaySpan = mw.html.create('span')
for i, class in ipairs(data.classes or {}) do
displaySpan:addClass(class)
end
displaySpan
:css{
['background-color'] = data.backgroundColor,
color = data.color
}
if data.style then
displaySpan:cssText(data.style)
end
displaySpan:wikitext(data.display)
display = tostring(displaySpan)
end
-- Render the link
local link
if p.nolink then
if p.urlisdisplay then
link = string.format('[[%s|%s]]', data.dummyLink, display)
else
link = string.format('%s', display)
end
else if data.isUrl then
link = string.format('[%s %s]', data.link, display)
else
link = string.format('[[%s|%s]]', data.link, display)
end
end
return string.format('<span class="plainlinks clickbutton">%s</span>', link)
end
function p.renderTrackingCategories(args)
if yesno(args.category) == false then
return ''
end
local class = args.class and args.class:lower()
if class == 'ui-button-green'
or class == 'ui-button-blue'
or class == 'ui-button-red'
then
return '[[Category:Pages using old style ui-button-color]]'
else
return ''
end
end
return p