# _icons URL: /api/rendering/plugins/directives/_icons/ Section: directives -------------------------------------------------------------------------------- _icons - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Plugins Directives ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module rendering.plugins.directives._icons Shared SVG icon utilities for directive rendering. Provides inline SVG icons from Bengal's icon library for use in cards, buttons, and other directives without requiring the full icon directive. Performance: Icons are lazily loaded on first access and cached Rendered output is LRU cached by (name, size, css_class, aria_label) Regex patterns are pre-compiled at module load Usage: from bengal.rendering.plugins.directives._icons import render_svg_icon icon_html = render_svg_icon("terminal", size=20) For directives that want warnings on missing icons: from bengal.rendering.plugins.directives._icons import ( render_svg_icon, icon_exists, warn_missing_icon, ) icon_html = render_svg_icon(icon_name, size=20) if not icon_html: warn_missing_icon(icon_name, directive="dropdown", context="My Dropdown Title") View source 10 Functions Functions _get_icons_directory Get the icons directory from the default theme. 0 Path Caret Right def _get_icons_directory() -> Path Get the icons directory from the default theme. Returns Path _load_icon Load an icon SVG by name (with caching). 1 str | None Caret Right def _load_icon(name: str) -> str | None Load an icon SVG by name (with caching). Parameters 1 Name Type Default Description name str — Icon name (without .svg extension) Returns str | None — SVG content string, or None if not found get_icon_svg Get raw SVG content for an icon. 1 str | None Caret Right def get_icon_svg(name: str) -> str | None Get raw SVG content for an icon. Parameters 1 Name Type Default Description name str — Icon name (e.g., "terminal", "search", "info") Returns str | None — Raw SVG string, or None if not found _escape_attr Escape HTML attribute value. 1 str Caret Right def _escape_attr(value: str) -> str Escape HTML attribute value. Parameters 1 Name Type Default Description value str — Returns str render_svg_icon Render an SVG icon for use in directives. Uses LRU caching to avoid repeated regex processing for … 4 str Caret Right def render_svg_icon(name: str, size: int = 20, css_class: str = '', aria_label: str = '') -> str Render an SVG icon for use in directives. Uses LRU caching to avoid repeated regex processing for identical icon render calls. Typical hit rate >95% for navigation icons. Applies ICON_MAP to resolve semantic names (e.g., "alert" -> "warning") before loading the icon file. Parameters 4 Name Type Default Description name str — Icon name (e.g., "terminal", "search", "info", "alert") size int 20 Icon size in pixels (default: 20) css_class str '' Additional CSS classes aria_label str '' Accessibility label Returns str — Inline SVG HTML string, or empty string if icon not found render_icon Render an icon by name, preferring Phosphor SVG icons. This function maps common icon names to Pho… 2 str Caret Right def render_icon(name: str, size: int = 20) -> str Render an icon by name, preferring Phosphor SVG icons. This function maps common icon names to Phosphor icons and always attempts to render SVG first. Only returns empty string if icon not found. Parameters 2 Name Type Default Description name str — Icon name (semantic name like "book", "rocket", etc.) size int 20 Icon size in pixels Returns str — HTML for icon (SVG only, empty string if not found) clear_icon_cache Clear both the raw icon cache and the render cache. Useful for testing or when icons are modified … 0 None Caret Right def clear_icon_cache() -> None Clear both the raw icon cache and the render cache. Useful for testing or when icons are modified during development. icon_exists Check if an icon exists in the icon library. This checks both direct icon names and mapped names f… 1 bool Caret Right def icon_exists(name: str) -> bool Check if an icon exists in the icon library. This checks both direct icon names and mapped names from ICON_MAP. Parameters 1 Name Type Default Description name str — Icon name to check Returns bool — True if icon exists, False otherwise warn_missing_icon Log a warning for a missing icon with helpful context. This centralizes icon warning logic so all … 3 None Caret Right def warn_missing_icon(icon_name: str, directive: str = '', context: str = '') -> None Log a warning for a missing icon with helpful context. This centralizes icon warning logic so all directives can use it without duplicating code. Parameters 3 Name Type Default Description icon_name str — The icon name that was not found directive str '' Name of the directive using the icon (e.g., "dropdown", "card") context str '' Additional context like element title for locating the issue get_available_icons Get list of all available icon names. Returns both the raw icon file names and the semantic aliase… 0 list[str] Caret Right def get_available_icons() -> list[str] Get list of all available icon names. Returns both the raw icon file names and the semantic aliases from ICON_MAP. Returns list[str] — Sorted list of available icon names Next → admonitions List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1693 - Reading Time: 8 minutes