Expand description
All official GitHub Octicons available for use in your Rust code. Designed for use in Rust server side templating code, such as maud templates. Each icon is available as a named static instance of struct that implements Display. The path or polygon data for that Octicon is also available as a static variable if you want to build your own svg elements.
If you do not like the default configuration, clone the static variable and use builder functions to customize it. The value and the presence of the svg attributes in the rendered output can both be configured.
§Example
use octicons;
println!("{}",
octicons::ARROW_DOWN.clone()
.xmlns(Some("http://www.w3.org/2000/svg"))
.width(32)
.height(32)
.fill(Some("#ff0"))
.aria_label(Some("hi"))
.class(Some("right left"))
);
// Path data
println!("{}", octicons::ARROW_DOWN_PATH);
§Maud Example
html! {
(PreEscaped(&octicons::DASH.to_string()))
}
Structs§
- Octicon
- Structure for Octicon configuration.
Enums§
Statics§
- ALERT
- ALERT_
PATH - ARROW_
DOWN - ARROW_
DOWN_ PATH - ARROW_
LEFT - ARROW_
LEFT_ PATH - ARROW_
RIGHT - ARROW_
RIGHT_ PATH - ARROW_
SMALL_ DOWN - ARROW_
SMALL_ DOWN_ PATH - ARROW_
SMALL_ LEFT - ARROW_
SMALL_ LEFT_ PATH - ARROW_
SMALL_ RIGHT - ARROW_
SMALL_ RIGHT_ PATH - ARROW_
SMALL_ UP - ARROW_
SMALL_ UP_ PATH - ARROW_
UP - ARROW_
UP_ PATH - BEAKER
- BEAKER_
PATH - BELL
- BELL_
PATH - BOLD
- BOLD_
PATH - BOOK
- BOOKMARK
- BOOKMARK_
PATH - BOOK_
PATH - BRIEFCASE
- BRIEFCASE_
PATH - BROADCAST
- BROADCAST_
PATH - BROWSER
- BROWSER_
PATH - BUG
- BUG_
PATH - CALENDAR
- CALENDAR_
PATH - CHECK
- CHECKLIST
- CHECKLIST_
PATH - CHECK_
PATH - CHEVRON_
DOWN - CHEVRON_
DOWN_ PATH - CHEVRON_
LEFT - CHEVRON_
LEFT_ PATH - CHEVRON_
RIGHT - CHEVRON_
RIGHT_ PATH - CHEVRON_
UP - CHEVRON_
UP_ PATH - CIRCLE_
SLASH - CIRCLE_
SLASH_ PATH - CIRCUIT_
BOARD - CIRCUIT_
BOARD_ PATH - CLIPPY
- CLIPPY_
PATH - CLOCK
- CLOCK_
PATH - CLOUD_
DOWNLOAD - CLOUD_
DOWNLOAD_ PATH - CLOUD_
UPLOAD - CLOUD_
UPLOAD_ PATH - CODE
- CODE_
PATH - COMMENT
- COMMENT_
DISCUSSION - COMMENT_
DISCUSSION_ PATH - COMMENT_
PATH - CREDIT_
CARD - CREDIT_
CARD_ PATH - DASH
- DASHBOARD
- DASHBOARD_
PATH - DASH_
PATH - DATABASE
- DATABASE_
PATH - DESKTOP_
DOWNLOAD - DESKTOP_
DOWNLOAD_ PATH - DEVICE_
CAMERA - DEVICE_
CAMERA_ PATH - DEVICE_
CAMERA_ VIDEO - DEVICE_
CAMERA_ VIDEO_ PATH - DEVICE_
DESKTOP - DEVICE_
DESKTOP_ PATH - DEVICE_
MOBILE - DEVICE_
MOBILE_ PATH - DIFF
- DIFF_
ADDED - DIFF_
ADDED_ PATH - DIFF_
IGNORED - DIFF_
IGNORED_ PATH - DIFF_
MODIFIED - DIFF_
MODIFIED_ PATH - DIFF_
PATH - DIFF_
REMOVED - DIFF_
REMOVED_ PATH - DIFF_
RENAMED - DIFF_
RENAMED_ PATH - ELLIPSIS
- ELLIPSIS_
PATH - EYE
- EYE_
PATH - FILE
- FILE_
BINARY - FILE_
BINARY_ PATH - FILE_
CODE - FILE_
CODE_ PATH - FILE_
DIRECTORY - FILE_
DIRECTORY_ PATH - FILE_
MEDIA - FILE_
MEDIA_ PATH - FILE_
PATH - FILE_
PDF - FILE_
PDF_ PATH - FILE_
SUBMODULE - FILE_
SUBMODULE_ PATH - FILE_
SYMLINK_ DIRECTORY - FILE_
SYMLINK_ DIRECTORY_ PATH - FILE_
SYMLINK_ FILE - FILE_
SYMLINK_ FILE_ PATH - FILE_
ZIP - FILE_
ZIP_ PATH - FLAME
- FLAME_
PATH - FOLD
- FOLD_
PATH - GEAR
- GEAR_
PATH - GIFT
- GIFT_
PATH - GIST
- GIST_
PATH - GIST_
SECRET - GIST_
SECRET_ PATH - GIT_
BRANCH - GIT_
BRANCH_ PATH - GIT_
COMMIT - GIT_
COMMIT_ PATH - GIT_
COMPARE - GIT_
COMPARE_ PATH - GIT_
MERGE - GIT_
MERGE_ PATH - GIT_
PULL_ REQUEST - GIT_
PULL_ REQUEST_ PATH - GLOBE
- GLOBE_
PATH - GRABBER
- GRABBER_
PATH - GRAPH
- GRAPH_
PATH - HEART
- HEART_
PATH - HISTORY
- HISTORY_
PATH - HOME
- HOME_
PATH - HORIZONTAL_
RULE - HORIZONTAL_
RULE_ PATH - HUBOT
- HUBOT_
PATH - INBOX
- INBOX_
PATH - INFO
- INFO_
PATH - ISSUE_
CLOSED - ISSUE_
CLOSED_ PATH - ISSUE_
OPENED - ISSUE_
OPENED_ PATH - ISSUE_
REOPENED - ISSUE_
REOPENED_ PATH - ITALIC
- ITALIC_
PATH - JERSEY
- JERSEY_
PATH - KEBAB_
HORIZONTAL - KEBAB_
HORIZONTAL_ PATH - KEBAB_
VERTICAL - KEBAB_
VERTICAL_ PATH - KEY
- KEYBOARD
- KEYBOARD_
PATH - KEY_
PATH - LAW
- LAW_
PATH - LIGHT_
BULB - LIGHT_
BULB_ PATH - LINK
- LINK_
EXTERNAL - LINK_
EXTERNAL_ PATH - LINK_
PATH - LIST_
ORDERED - LIST_
ORDERED_ PATH - LIST_
UNORDERED - LIST_
UNORDERED_ PATH - LOCATION
- LOCATION_
PATH - LOCK
- LOCK_
PATH - LOGO_
GIST - LOGO_
GIST_ PATH - LOGO_
GITHUB - LOGO_
GITHUB_ PATH - MAIL_
PATH - MAIL_
READ - MAIL_
READ_ PATH - MARKDOWN
- MARKDOWN_
PATH - MARK_
GITHUB - MARK_
GITHUB_ PATH - MEGAPHONE
- MEGAPHONE_
PATH - MENTION
- MENTION_
PATH - MILESTONE
- MILESTONE_
PATH - MIRROR
- MIRROR_
PATH - MORTAR_
BOARD - MORTAR_
BOARD_ PATH - MUTE
- MUTE_
PATH - NOTE
- NOTE_
PATH - NO_
NEWLINE - NO_
NEWLINE_ PATH - OCTOFACE
- OCTOFACE_
PATH - ORGANIZATION
- ORGANIZATION_
PATH - PACKAGE
- PACKAGE_
PATH - PAINTCAN
- PAINTCAN_
PATH - PENCIL
- PENCIL_
PATH - PERSON
- PERSON_
PATH - PIN
- PIN_
PATH - PLUG
- PLUG_
PATH - PLUS
- PLUS_
PATH - PLUS_
SMALL - PLUS_
SMALL_ PATH - PRIMITIVE_
DOT - PRIMITIVE_
DOT_ PATH - PRIMITIVE_
SQUARE - PRIMITIVE_
SQUARE_ PATH - PROJECT
- PROJECT_
PATH - PULSE
- PULSE_
PATH - QUESTION
- QUESTION_
PATH - QUOTE
- QUOTE_
PATH - RADIO_
TOWER - RADIO_
TOWER_ PATH - REPLY
- REPLY_
PATH - REPO
- REPO_
CLONE - REPO_
CLONE_ PATH - REPO_
FORCE_ PUSH - REPO_
FORCE_ PUSH_ PATH - REPO_
FORKED - REPO_
FORKED_ PATH - REPO_
PATH - REPO_
PULL - REPO_
PULL_ PATH - REPO_
PUSH - REPO_
PUSH_ PATH - ROCKET
- ROCKET_
PATH - RSS
- RSS_
PATH - RUBY
- RUBY_
PATH - SCREEN_
FULL - SCREEN_
FULL_ PATH - SCREEN_
NORMAL - SCREEN_
NORMAL_ PATH - SEARCH
- SEARCH_
PATH - SERVER
- SERVER_
PATH - SETTINGS
- SETTINGS_
PATH - SHIELD
- SHIELD_
PATH - SIGN_IN
- SIGN_
IN_ PATH - SIGN_
OUT - SIGN_
OUT_ PATH - SMILEY
- SMILEY_
PATH - SQUIRREL
- SQUIRREL_
PATH - STAR
- STAR_
PATH - STOP
- STOP_
PATH - SYNC
- SYNC_
PATH - TAG
- TAG_
PATH - TASKLIST
- TASKLIST_
PATH - TELESCOPE
- TELESCOPE_
PATH - TERMINAL
- TERMINAL_
PATH - TEXT_
SIZE - TEXT_
SIZE_ PATH - THREE_
BARS - THREE_
BARS_ PATH - THUMBSDOWN
- THUMBSDOWN_
PATH - THUMBSUP
- THUMBSUP_
PATH - TOOLS
- TOOLS_
PATH - TRASHCAN
- TRASHCAN_
PATH - TRIANGLE_
DOWN - TRIANGLE_
DOWN_ PATH - TRIANGLE_
LEFT - TRIANGLE_
LEFT_ PATH - TRIANGLE_
RIGHT - TRIANGLE_
RIGHT_ PATH - TRIANGLE_
UP - TRIANGLE_
UP_ PATH - UNFOLD
- UNFOLD_
PATH - UNMUTE
- UNMUTE_
PATH - UNVERIFIED
- UNVERIFIED_
PATH - VERIFIED
- VERIFIED_
PATH - VERSIONS
- VERSIONS_
PATH - WATCH
- WATCH_
PATH - X
- X_PATH
- ZAP
- ZAP_
PATH