Modulo:Materialize colors examples: differenze tra le versioni

Versione delle 23:20, 4 apr 2022

Versione delle 16:06, 5 apr 2022

Riga 1:

--- ModuleThis module was created to generate the examples in this page:

-- [[Template:Materialize colors]]

-- https://it.wikipedia.org/wiki/Template:Materialize_colors

--

-- CODE STYLE:

-- We are trying to make the module easy to be shared in other wikis so without external dependencies.

-- To be updated, import the version from:

-- [[w:it:Modulo:Materialize_colors_examples]]

-- https://it.wikipedia.org/wiki/Modulo:Materialize_colors_examples

---

--- LOCAL FUNCTIONS

---

---

-- Remove empty elements from a table

--

-- @param args table

-- @return table

local function cleanWikitextArguments( args )

local result = {}

for k, v in pairs( args ) do

-- eventually trim

if type( v ) == 'string' then

v = mw.text.trim( v )

-- promote to nil

if v == '' then

v = nil

end

end

if v then

result[ k ] = v

end

end

return result

end

---

-- Array replace

--

-- This somehow emulates the PHP array_replace()

--

-- @param table..

-- @return table

--

local function arrayReplace( ... )

-- final table

local complete = {}

-- table with all the arguments

local args = { ... }

-- for each table

for _, arg in pairs( args ) do

-- merge all the consecutive tables in the complete one

for k, v in pairs( arg ) do

-- the most left value takes precedence

complete[ k ] = v

end

end

return complete

end

---

-- Merge some frame arguments

--

-- @return table

local function frameArguments( frame )

local argsParent = cleanWikitextArguments( frame:getParent().args or {} )

local args = cleanWikitextArguments( frame.args )

return arrayReplace( args, argsParent )

end

--- Add a space in front of a CSS class

-- @param a

-- @param b string or nil

-- @return string

local function addStartingSpace( a )

local s = a or ""

if s ~= "" then

s = " " .. s

end

return s

end

--- Concat two CSS classes with a space

-- @param a string or nil

-- @param b string or nil

-- @return string

local function concatClasses( a, b )

local s = a or ""

return s .. addStartingSpace( b )

end

--

Line 30 ⟶ 130:

---

-- Constructor for a MaterialFlavor

-- @param name namebase of the color flavor (e.g. "darken" for "darken-2")

-- @param isDarki whenevernumeric it'sindex aof darkthe color flavor or not (e.g. true2 for "darken-2")

-- @param isDark whenever it's a dark flavor (e.g. true if it needs white text)

-- @return MaterialFlavor

function MaterialFlavor:new( namebase, i, isDark )

base = base or ''

i = i or ''

local materialFlavor = {

namebase = namebase,

i = i,

name = base .. "-" .. i,

isDark = isDark or false,

}

Line 70 ⟶ 175:

function MaterialColorFlavor:getContainerCSSClass()

local s = self.color

if self.flavor.name ~= nil then

s = s +.. " " +.. self.flavor.name

end

return s

end

Line 84 ⟶ 187:

-- @return string

function MaterialColorFlavor:getContainerCSSClassAndTextClass()

return concatClasses(

local s = self:getContainerCSSClassSimple()

self:getContainerCSSClass(),

local extraCSSClass = self:getTextCSSClass()

self:getTextCSSClass()

if extraCSSClass ~= nil then

)

s = s + " " + extraCSSClass

end

return s

end

--- Constructor for a MaterialColor

-- @param color name of the color e.g. 'red'

-- @param skipAccent whenever to skip the "accents" flavor

function MaterialColor:new( color )

function MaterialColor:new( color, skipAccent )

-- no color no party

if color == nil then

error( "missing color name (e.g. red)" )

end

local materialColor = {

color = color,

skip = {

accent = skipAccent or true and false,

},

}

setmetatable( materialColor, MaterialColor )

Line 102 ⟶ 213:

end

--- GetDo allsomething thefor each color flavorsflavor

-- @param doSomething Your custom function - the first argument will be a MaterialColorFlavor

-- @param color name of the color e.g. 'red'

function MaterialColor:getColorFlavorseachColorFlavor( flavors, doSomething )

localfor i, flavor in pairs( flavors =) {}do

if not self.skip[ flavor.base ] then

for i, flavor in pairs( KNOWN_FLAVORS ) do

flavors[ i ] = doSomething( MaterialColorFlavor:new( self.color, flavor ) )

end

end

return flavors

end

--- Create an HTML palette (a stack of colorized divs)

---

function MaterialColor:createPaletteHTML( flavors, containerClass )

--- CONSTANTS

local s = ""

---

local APIX = "\""

containerClass = addStartingSpace( containerClass )

--- a complete array of generic color flavors

local KNOWN_FLAVORS = {

-- for each color flavor, create some HTML

MaterialFlavor:new( "lighten-5" ),

self:eachColorFlavor( flavors, function( flavor )

MaterialFlavor:new( "lighten-4" ),

s = s .. "<div class=" .. APIX

MaterialFlavor:new( "lighten-3" ),

-- start HTML class name:

MaterialFlavor:new( "lighten-2" ),

.. flavor:getContainerCSSClassAndTextClass()

MaterialFlavor:new( nil ), -- default color

.. containerClass

MaterialFlavor:new( "darken-1", true ),

.. APIX .. ">"

MaterialFlavor:new( "darken-2", true ),

-- displayed text:

MaterialFlavor:new( "darken-3", true ),

.. flavor:getContainerCSSClass()

MaterialFlavor:new( "darken-4", true ),

.. "</div>\n"

MaterialFlavor:new( "accent-1" ),

end )

MaterialFlavor:new( "accent-2" ),

MaterialFlavor:new( "accent-3" ),

return s

MaterialFlavor:new( "accent-4" ),

end

}

-- create a new package

local p = {}

-- save a color flavor

--- main method

function p.main_newFlavor( framebase, i, isDark )

p._KNOWN_FLAVORS[ #p._KNOWN_FLAVORS +1 ] = MaterialFlavor:new( base, i, isDark )

end

-- save a color by its name

local s = ''

function p._newColor( color, skipAccent )

p._KNOWN_COLORS[ color ] = MaterialColor:new( color, skipAccent )

end

---

-- inherit the frame

--- INITIALIZATION

frame = frame or mw.getCurrentFrame()

---

--- a complete array of generic color flavors

-- color argument

p._KNOWN_FLAVORS = {}

local color = frame.color

p._newFlavor( "lighten", 5 )

p._newFlavor( "lighten", 4 )

p._newFlavor( "lighten", 3 )

p._newFlavor( "lighten", 2 )

p._newFlavor( nil , nil ) -- yup, the default color without flavor

p._newFlavor( "darken" , 1, true ) -- dark version with white text

p._newFlavor( "darken" , 2, true )

p._newFlavor( "darken" , 3, true )

p._newFlavor( "darken" , 4, true )

p._newFlavor( "accent" , 1 )

p._newFlavor( "accent" , 2 )

p._newFlavor( "accent" , 3 )

p._newFlavor( "accent" , 4 )

--- a complete array of known colors indexed by name

local materialColor = MaterialColor:new( color )

p._KNOWN_COLORS = {}

p._newColor( "red" )

p._newColor( "pink" )

p._newColor( "purple" )

p._newColor( "deep-purple" )

p._newColor( "indigo" )

p._newColor( "blue" )

p._newColor( "light-blue" )

p._newColor( "cyan" )

p._newColor( "teal" )

p._newColor( "green" )

p._newColor( "light-green" )

p._newColor( "lime" )

p._newColor( "yellow" )

p._newColor( "amber" )

p._newColor( "orange" )

p._newColor( "deep-orange" )

p._newColor( "brown" , true ) -- no "accent"

p._newColor( "grey" , true ) -- no "accent"

p._newColor( "blue-grey" , true ) -- no "accent"

---

local apix = "\""

--- CORE FUNCTIONS

---

-- get a color by its name

for i, colorFlavor in pairs( materialColor:getColorFlavors() ) do

function p._getColor( name )

return p._KNOWN_COLORS[ name ] or error( "unknown color" )

end

--- Generate an HTML color palette

s = s + "<div class=" + apix

-- This function should be called from Lua

+ flavor:getContainerCSSClassAndTextClass()

function p._paletteHTML( args )

+ apix + ">"

args = args or {}

+ flavor:getContainerCSSClass()

+ "</div>"

end

-- arguments

return s

local color = args.color

local containerClass = args.containerClass

-- find the color and generate the HTML palette

return p._getColor( color )

:createPaletteHTML( p._KNOWN_FLAVORS, containerClass )

end

--- Generate an HTML color palette

-- This function should be called from wikitext

function p.paletteHTML( frame )

local args = frameArguments( frame )

return p._paletteHTML( args )

end