Module:OOO/Variants

Documentation for this module may be created at Module:OOO/Variants/doc

-- Module:OOO/Variants
-- Renders a TabberNeue block of OOOInfoBox variants, wrapped so it aligns with the infobox.
-- Usage:
--   {{OOOVariants|400162|400163|400113|400169|400170}}
--   {{OOOVariants | label1=2 m | art1=400162 | label2=3 m | art2=400163 | width=300 | align=left | mode=scroll }}
--
-- Global params:
--   |domain=Buildings       -- bucket to read from (default: Buildings)
--   |align=right|left|none|center
--   |width=300              -- px; applies to wrapper + OOOInfoBox (240–600)
--   |mode=wrap|scroll       -- wrap (default) or horizontal scroll (adds class used by gadget)
--
-- Per-tab overrides (append N):
--   |labelN=... |imageN=... |descriptionN=... |dimensionsN=... |classN=...

local DATA = require('Module:OOO/Data')

local p = {}

local PASSTHROUGH = { 'image', 'description', 'dimensions', 'class' }

local function tostring_or_nil(v)
  if v == nil then return nil end
  return tostring(v)
end

local function safe_label(s)
  s = tostring(s or '')
  s = s:gsub('|', '|'):gsub('=', '=')
  return s
end

local function label_for(domain, art, given)
  if given and given ~= '' then return given end
  local rec = DATA.get(domain, art) or {}
  return rec.displayName or tostring(art)
end

function p.tabs(frame)
  local parent = frame:getParent() or frame
  local args   = parent.args or {}

  local domain = tostring_or_nil(args.domain or args.type) or 'Buildings'
  local align  = tostring_or_nil(args.align) or 'right'
  local mode   = tostring_or_nil(args.mode)  or 'wrap'     -- 'wrap' (default) or 'scroll'
  local width  = tonumber(args.width)

  -- Build each tab entry
  local entries = {}
  local i = 1
  while true do
    local art = args['art'..i] or args[i]
    if not art then break end

    local label = label_for(domain, art, args['label'..i] or args['name'..i])

    -- Args forwarded to OOOInfoBox
    local ibx = {
      art   = art,
      type  = domain,
      align = align,
    }
    if width and width >= 240 and width <= 600 then
      ibx.width = width
    end
    for _, key in ipairs(PASSTHROUGH) do
      local v = args[key..i]
      if v and v ~= '' then ibx[key] = v end
    end

    local content = frame:expandTemplate{ title = 'OOOInfoBox', args = ibx }
    entries[#entries+1] = string.format('%s=\n%s\n', safe_label(label), content)

    i = i + 1
  end

  if #entries == 0 then
    return '<strong class="error">OOOVariants: no variants provided</strong>'
  end

  local inner  = table.concat(entries, '|-|\n')
  local tabber = frame:extensionTag('tabber', inner)

  -- Wrapper around tabber so it floats with the infobox and gets our styles
  local wrap = mw.html.create('div'):addClass('ooo-infobox-tabwrap')
  if align == 'left' then
    wrap:addClass('ooo-infobox-tabwrap--left')
  elseif align == 'none' then
    wrap:addClass('ooo-infobox-tabwrap--none')
  elseif align == 'center' then
    wrap:addClass('ooo-infobox-tabwrap--center')
  end
  if mode == 'scroll' then
    -- enables horizontal-scroll mode + arrow gadget hook
    wrap:addClass('ooo-infobox-tabwrap--scroll')
  end
  if width and width >= 240 and width <= 600 then
    wrap:css('width', tostring(width) .. 'px')
  end

  wrap:wikitext(tabber)

  -- Attach wrapper TemplateStyles
  local html = tostring(wrap)
  html = html .. frame:extensionTag('templatestyles', '', { src = 'Template:OOOInfoBoxTabber/styles.css' })

  -- Optional debug comment
  if tostring(args.debug) == '1' then
    html = html .. string.format('<!-- OOOVariants: domain=%s, align=%s, mode=%s, width=%s, tabs=%d -->',
      domain, align, mode, width or 'default', #entries)
  end

  return html
end

return p