Wikipedia

Modulo:Materialize colors examples: differenze tra le versioni

Naviga nella cronologia in modo interattivo
Contenuto cancellato Contenuto aggiunto
pubblicazione work in progress per Template:Materialize colors
 
+possibilità di avere i colori dei testi
 
(5 versioni intermedie di uno stesso utente non sono mostrate)
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 )
local name = base
if i then
name = name .. "-" .. i
end
local materialFlavor = {
base = base,
i = i,
name = name,
isDark = isDark or false,
Line 59 ⟶ 166:
-- Get the CSS class name for the text
-- @return string
function MaterialColorFlavor:getTextCSSClass( isText )
return self.flavor.isDark and not isText and 'white-text' or nil
end
 
---
-- Constructor for a MaterialColorFlavor
-- @param colorisText nameWhenever ofthis theshould colornot e.g.be '"red' darken-1" but "red-text text-darken-1"
-- @param flavor reference to a MaterialFlavor
-- @return string
function MaterialColorFlavor:getContainerCSSClass( isText )
local stextPrefix = self.colorisText and 'text-' or ''
local textSuffix = isText and '-text' or ''
 
local cssClass = self.color .. textSuffix
if self.flavor.name ~= nil then
s = s + " " + if self.flavor.name then
cssClass = cssClass .. " " .. textPrefix .. self.flavor.name
end
return cssClass
return s
end
 
---
-- Get the container's CSS class, plus the text class (if any)
-- @param colorisText nameWhenever ofthis theshould colornot e.g.be '"red' darken-1" but "red-text text-darken-1"
-- @param flavor reference to a MaterialFlavor
-- @return string
function MaterialColorFlavor:getContainerCSSClassAndTextClass( isText )
return concatClasses(
local s = self:getContainerCSSClassSimple()
self:getContainerCSSClass( isText ),
local extraCSSClass = self:getTextCSSClass()
self:getTextCSSClass( isText )
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 skip Table of flavor names to be skipped (e.g. { darken = true } to skip darken )
function MaterialColor:new( color )
function MaterialColor:new( color, skip )
 
-- no color no party
if color == nil then
error( "missing color name (e.g. red)" )
end
 
local materialColor = {
color = color,
skip = skip or {},
}
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
end
return flavors
 
--- Create an HTML palette (a stack of colorized divs)
function MaterialColor:createPaletteHTML( flavors, args )
local s = ""
local APIX = "\""
 
local colorPre = args.colorPre or ''
local colorPost = args.colorPost or '\n'
local colorExtraClass = addStartingSpace( args.colorExtraClass )
local isText = tostring( args.isText ) == '1'
 
-- for each color flavor, create some HTML
self:eachColorFlavor( flavors, function( flavor )
s = s .. colorPre
.. "<div class=" .. APIX
-- start HTML class name:
.. flavor:getContainerCSSClassAndTextClass( isText )
.. colorExtraClass
.. APIX .. ">"
-- displayed text:
.. flavor:getContainerCSSClass( isText )
.. "</div>"
.. colorPost
end )
 
return s
end
 
-- create a new package
local p = {}
 
-- Internal function to save a new color by name
function p._newColor( color, skip )
-- index by name
p._KNOWN_COLORS_BY_NAME[ color ] = MaterialColor:new( color, skip )
 
-- index by desired order
p._KNOWN_COLORS_BY_ORDER[ #p._KNOWN_COLORS_BY_ORDER + 1 ] = p._KNOWN_COLORS_BY_NAME[ color ]
end
 
Line 116 ⟶ 266:
---
 
local SKIP_ACCENTS = {
--- a complete array of generic color flavors
accent = true, -- skip flavor accent
local KNOWN_FLAVORS = {
MaterialFlavor:new( "lighten-5" ),
MaterialFlavor:new( "lighten-4" ),
MaterialFlavor:new( "lighten-3" ),
MaterialFlavor:new( "lighten-2" ),
MaterialFlavor:new( nil ), -- default color
MaterialFlavor:new( "darken-1", true ),
MaterialFlavor:new( "darken-2", true ),
MaterialFlavor:new( "darken-3", true ),
MaterialFlavor:new( "darken-4", true ),
MaterialFlavor:new( "accent-1" ),
MaterialFlavor:new( "accent-2" ),
MaterialFlavor:new( "accent-3" ),
MaterialFlavor:new( "accent-4" ),
}
 
local NOT_REALLY_A_COLOR = {
-- create a new package
accent = true, -- skip flavor accent
local p = {}
lighten = true, -- skip flavor lighten
darken = true, -- skip flavor darken
}
 
---
--- main method
--- INITIALIZATION
function p.main( frame )
---
-- special flavors useful for black and white
p._SPECIAL_FLAVOR_NEUTRAL = MaterialFlavor:new( nil, nil ) -- just color, no flavor
p._SPECIAL_FLAVOR_DARK = MaterialFlavor:new( nil, nil, true ) -- just color, no flavor, is dark
 
--- a complete palette of generic color flavors
local s = ''
p._KNOWN_FLAVORS = {
MaterialFlavor:new( "lighten", 5 ),
MaterialFlavor:new( "lighten", 4 ),
MaterialFlavor:new( "lighten", 3 ),
MaterialFlavor:new( "lighten", 2 ),
p._SPECIAL_FLAVOR_NEUTRAL, -- yup, the default color without flavor
MaterialFlavor:new( "darken" , 1, true ), -- dark version with white text
MaterialFlavor:new( "darken" , 2, true ), -- dark version with white text
MaterialFlavor:new( "darken" , 3, true ), -- dark version with white text
MaterialFlavor:new( "darken" , 4, true ), -- dark version with white text
MaterialFlavor:new( "accent" , 1 ),
MaterialFlavor:new( "accent" , 2 ),
MaterialFlavor:new( "accent" , 3 ),
MaterialFlavor:new( "accent" , 4 ),
}
 
--- a complete array of known colors indexed by name
-- inherit the frame
p._KNOWN_COLORS_BY_ORDER = {}
frame = frame or mw.getCurrentFrame()
p._KNOWN_COLORS_BY_NAME = {}
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" , SKIP_ACCENTS )
p._newColor( "grey" , SKIP_ACCENTS )
p._newColor( "blue-grey" , SKIP_ACCENTS )
 
-- add other special colors
-- color argument
p._WHITE = MaterialColor:new( "white", NOT_REALLY_A_COLOR )
local color = frame.color
p._BLACK = MaterialColor:new( "black", NOT_REALLY_A_COLOR )
 
---
local materialColor = MaterialColor:new( color )
--- CORE FUNCTIONS
---
 
-- get a color by its name
local apix = "\""
function p._getColor( name )
return p._KNOWN_COLORS_BY_NAME[ name ] or error( "unknown color: " .. tostring( name ) )
end
 
--- Generate an HTML color palette
for i, colorFlavor in pairs( materialColor:getColorFlavors() ) do
-- This function should be called from Lua
function p._paletteHTML( args )
args = args or {}
 
-- find the color and generate the HTML palette
s = s + "<div class=" + apix
return p._getColor( args.color )
+ flavor:getContainerCSSClassAndTextClass()
:createPaletteHTML( p._KNOWN_FLAVORS, args )
+ apix + ">"
end
+ flavor:getContainerCSSClass()
 
+ "</div>"
--- 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
 
--- Generate an HTML color palette
-- This function should be called from Lua
function p._paletteHTML( args )
 
-- arguments
args = args or {}
 
-- find the color and generate the HTML palette
return p._getColor( args.color )
:createPaletteHTML( p._KNOWN_FLAVORS, args )
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
 
--- Generate an HTML color palette
-- This function should be called from Lua
function p._allPalettesHTML( args )
 
local s = ""
 
-- arguments
args = args or {}
local containerPre = args.containerPre or ''
local containerPost = args.containerPost or ''
 
-- generate all palettes (but not white and black)
for i, color in pairs( p._KNOWN_COLORS_BY_ORDER ) do
s = s .. containerPre
s = s .. color:createPaletteHTML( p._KNOWN_FLAVORS, args )
s = s .. containerPost
end
 
-- generate also a nice palette for white and black
s = s .. containerPre
s = s .. p._WHITE:createPaletteHTML( { p._SPECIAL_FLAVOR_NEUTRAL }, args )
s = s .. p._BLACK:createPaletteHTML( { p._SPECIAL_FLAVOR_DARK }, args )
s = s .. containerPost
 
-- find the color and generate the HTML palette
return s
end
 
--- Generate an HTML color palette
-- This function should be called from wikitext
function p.allPalettesHTML( frame )
local args = frameArguments( frame )
return p._allPalettesHTML( args )
end
 
Estratto da "https://it.wikipedia.org/wiki/Modulo:Materialize_colors_examples"