Module:Navigation header/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 20:25, 24 September 2023

This module depends on the following other modules:

This module uses TemplateStyles:

main(frame: table) -> string

Takes a frame object containing the template's arguments and generates a navigation header.

frame: A table containing the arguments passed to the module.

Returns: A string representing the generated HTML for the navigation header.

_main(args: table) -> string

Takes an args object containing another module's arguments into this module and does the same as above.

@@ Line 1: / Line 1: @@
+{{Lua|Module:Standard icons|Module:Shortcut}}
-Provides functionality to [[Template:Navigation header]]
+{{Uses TemplateStyles|Module:Navigation header/styles.css}}
-=== Functions ===
+Implements [[Template:Navigation header]].
-==== getIcon ====
-getIcon(key: string) -> string
+== Functions ==
-Takes an icon key and returns the corresponding icon filename from the standard icons table.
+=== main ===
-'''key''': A string representing the key for the standard icon.
+ main(frame: table) -> string
+Takes a frame object containing the template's arguments and generates a navigation header.
-Returns: The filename of the corresponding icon from the standard icons table, or the input key if the key is not found in the table.
-==== navigationHeader ====
-navigationHeader(frame: table) -> string
-Takes a frame object containing the module's arguments and generates a navigation header.
 '''frame''': A table containing the arguments passed to the module.
@@ Line 19: / Line 14: @@
 Returns: A string representing the generated HTML for the navigation header.
-=== Usage ===
+=== _main ===
+ _main(args: table) -> string
-See [[Template:Navigation header]]
+Takes an args object containing another module's arguments into this module and does the same as above.