From d7752291dabf383873fb111d5341d6105ceac4e4 Mon Sep 17 00:00:00 2001 From: jonthegeek Date: Tue, 29 Oct 2024 12:21:55 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20shinywor?= =?UTF-8?q?ks/favawesome@59c17e007df027c3fb61ce846292f8ff54fb8d9d=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 2 +- CODE_OF_CONDUCT.html | 2 +- CONTRIBUTING.html | 4 +- LICENSE-text.html | 2 +- LICENSE.html | 2 +- SUPPORT.html | 2 +- authors.html | 10 +-- index.html | 16 ++--- news/index.html | 9 ++- pkgdown.yml | 2 +- reference/dot-fav_as_href.html | 2 +- reference/dot-fav_encode.html | 2 +- reference/fav.html | 10 +-- reference/favawesome-package.html | 12 ++-- reference/index.html | 8 ++- reference/use_favawesome_standalone.html | 85 ++++++++++++++++++++++++ search.json | 2 +- sitemap.xml | 1 + 18 files changed, 135 insertions(+), 38 deletions(-) create mode 100644 reference/use_favawesome_standalone.html diff --git a/404.html b/404.html index aac7b40..0d6b328 100644 --- a/404.html +++ b/404.html @@ -21,7 +21,7 @@ favawesome - 0.1.0 + 0.1.0.9000 + + + + + +
+
+
+

Add favawesome_icon Function to a Project

+ Source: R/use_favawesome_standalone.R +
use_favawesome_standalone.Rd
+
+ +
+

If you can't import favawesome in your project, you can still use a Font +Awesome (https://fontawesome.com) icon as the favicon (the icon that +appears on browser tabs). Calling this function will download the necessary +code to add a favawesome_icon() function to your project, and will ovewrite +the existing file if it already exists, making it easy to update the code. +The favawesome_icon() function takes the same arguments as fav().

+
+ +
+

Usage

+ 
use_favawesome_standalone()
+
+ +
+

Value

+

NULL invisibly (called for side effect of importing the +favawesome_icon() definition). favawesome_icon() returns the same value +as fav().

+
+ +
+ + +
+

Developed by Jon Harmon.

+
+ +
+

Site built with pkgdown 2.1.1.

+
+ +
+ + + + + + + diff --git a/search.json b/search.json index b66703f..ba41e54 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement jonthegeek@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to favawesome","title":"Contributing to favawesome","text":"outlines propose change favawesome.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to favawesome","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to favawesome","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to favawesome","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"shinyworks/favawesome\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to favawesome","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to favawesome","text":"Please note favawesome project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://favawesome.shinyworks.org/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 favawesome authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with favawesome","title":"Getting help with favawesome","text":"Thanks using favawesome! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with favawesome","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with favawesome","text":"Armed reprex, next step figure ask. ’s question: ’s best ask R4DS Online Learning Community Slack. options include Posit Community, StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with favawesome","text":"’ll try look issue soon can, packages maintained volunteers. good reprex particularly important might weeks months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://favawesome.shinyworks.org/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Jon Harmon. Author, maintainer, copyright holder.","code":""},{"path":"https://favawesome.shinyworks.org/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Harmon J (2024). favawesome: 'Font Awesome' Icons 'Shiny' 'favicons'. R package version 0.1.0, https://github.com/shinyworks/favawesome, https://favawesome.shinyworks.org.","code":"@Manual{, title = {favawesome: 'Font Awesome' Icons as 'Shiny' 'favicons'}, author = {Jon Harmon}, year = {2024}, note = {R package version 0.1.0, https://github.com/shinyworks/favawesome}, url = {https://favawesome.shinyworks.org}, }"},{"path":"https://favawesome.shinyworks.org/index.html","id":"favawesome-","dir":"","previous_headings":"","what":"Font Awesome Icons as Shiny favicons","title":"Font Awesome Icons as Shiny favicons","text":"Easily use {fontawesome} icons Shiny favicons (icons appear browser tabs). Font Awesome popular set icons can used web pages. {favawesome} provides simple way use icons favicons Shiny applications HTML pages.","code":""},{"path":"https://favawesome.shinyworks.org/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Font Awesome Icons as Shiny favicons","text":"can install development version favawesome GitHub :","code":"# install.packages(\"pak\") pak::pak(\"shinyworks/favawesome\")"},{"path":"https://favawesome.shinyworks.org/index.html","id":"motivation","dir":"","previous_headings":"","what":"Motivation","title":"Font Awesome Icons as Shiny favicons","text":"’ve spent time Chrome Developer Tools Console (ctrl + shift + ) Shiny apps, may seen familiar error message: False alarms make easy miss real error messages, wanted way silence error message without adding bunch dependencies shiny app. package add dependencies already required {shiny}.","code":""},{"path":"https://favawesome.shinyworks.org/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Font Awesome Icons as Shiny favicons","text":"Add call favawesome::fav() Shiny UI code HTML.","code":"html_page <- htmltools::tags$html( favawesome::fav(\"earth-africa\", fill = \"blue\"), htmltools::tags$body( htmltools::tags$h1(\"Hello world!\"), htmltools::tags$p(\"(on the browser tab)\") ) ) htmltools::html_print(html_page, viewer = utils::browseURL)"},{"path":"https://favawesome.shinyworks.org/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Font Awesome Icons as Shiny favicons","text":"Please note {favawesome} project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":null,"dir":"Reference","previous_headings":"","what":"Add data URI prefix to base64-encoded icon — .fav_as_href","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"Add data URI prefix base64-encoded icon","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"","code":".fav_as_href(fav_base64)"},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"fav_base64 base64-encoded character vector generated .fav_encode().","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"base64-encoded icon data URI prefix.","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":null,"dir":"Reference","previous_headings":"","what":"Load Font Awesome icon and encode — .fav_encode","title":"Load Font Awesome icon and encode — .fav_encode","text":"Load Font Awesome icon encode","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load Font Awesome icon and encode — .fav_encode","text":"","code":".fav_encode(name, ...)"},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load Font Awesome icon and encode — .fav_encode","text":"name name Font Awesome icon. short name (e.g., \"npm\", \"drum\", etc.), , full name (e.g., \"fab fa-npm\", \"fas fa-drum\", etc.). names correspond current Version 6 Font Awesome names. list short full names can accessed fa_metadata() function fa_metadata()$icon_names fa_metadata()$icon_names_full. supplying previous name associated icon, internally translated current name Version 6 icon returned. ... Arguments passed fontawesome::fa fill,fill_opacity fill color icon can set fill. provided default value \"currentColor\" applied SVG fill matches color parent HTML element's color attribute. opacity level SVG fill can controlled decimal value 0 1. stroke,stroke_width,stroke_opacity stroke options allow setting color, width, opacity SVG outline stroke. default, stroke width small \"1px\" size adjustment \"stroke_width\" can useful. \"stroke_opacity\" value can decimal values 0 1 (bounds included). height,width height width style attributes rendered SVG. nothing provided height default value \"1em\" applied. width given, calculated units \"em\" basis icon's SVG \"viewBox\" dimensions. margin_left,margin_right length value margin either left right icon. default, \"auto\" used properties. space needed either side length \"0.2em\" recommended starting point. vertical_align vertical alignment icon. default, length \"-0.125em\" used. position value position style attribute. default, \"relative\" used . title option populating SVG 'title' attribute, provides -hover text icon. default, title text given icon. a11y == \"semantic\" title text automatically given rendered icon, however, providing text override . prefer_type Chooses type icon returned : (1) providing short name, (2) icon solid regular types. example, using name = \"address-book\" result two types icons Address Book. default, preference set \"regular\" option \"solid\". a11y Cases distinguish role icon inform accessibility attributes used. Icons can either \"deco\" (decorative, default case) \"sem\" (semantic). Using \"none\" result accessibility features icon.","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load Font Awesome icon and encode — .fav_encode","text":"base64-encoded character vector representing icon png.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":null,"dir":"Reference","previous_headings":"","what":"Use Font Awesome icons as favicons — fav","title":"Use Font Awesome icons as favicons — fav","text":"Generate html necessary use Font Awesome icon favicon (icon appears browser tabs) Shiny app HTML document.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use Font Awesome icons as favicons — fav","text":"","code":"fav(name, ...)"},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use Font Awesome icons as favicons — fav","text":"name name Font Awesome icon. short name (e.g., \"npm\", \"drum\", etc.), , full name (e.g., \"fab fa-npm\", \"fas fa-drum\", etc.). names correspond current Version 6 Font Awesome names. list short full names can accessed fa_metadata() function fa_metadata()$icon_names fa_metadata()$icon_names_full. supplying previous name associated icon, internally translated current name Version 6 icon returned. ... Arguments passed fontawesome::fa fill,fill_opacity fill color icon can set fill. provided default value \"currentColor\" applied SVG fill matches color parent HTML element's color attribute. opacity level SVG fill can controlled decimal value 0 1. stroke,stroke_width,stroke_opacity stroke options allow setting color, width, opacity SVG outline stroke. default, stroke width small \"1px\" size adjustment \"stroke_width\" can useful. \"stroke_opacity\" value can decimal values 0 1 (bounds included). height,width height width style attributes rendered SVG. nothing provided height default value \"1em\" applied. width given, calculated units \"em\" basis icon's SVG \"viewBox\" dimensions. margin_left,margin_right length value margin either left right icon. default, \"auto\" used properties. space needed either side length \"0.2em\" recommended starting point. vertical_align vertical alignment icon. default, length \"-0.125em\" used. position value position style attribute. default, \"relative\" used . title option populating SVG 'title' attribute, provides -hover text icon. default, title text given icon. a11y == \"semantic\" title text automatically given rendered icon, however, providing text override . prefer_type Chooses type icon returned : (1) providing short name, (2) icon solid regular types. example, using name = \"address-book\" result two types icons Address Book. default, preference set \"regular\" option \"solid\". a11y Cases distinguish role icon inform accessibility attributes used. Icons can either \"deco\" (decorative, default case) \"sem\" (semantic). Using \"none\" result accessibility features icon.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Use Font Awesome icons as favicons — fav","text":"shiny.tag (see htmltools::tag()) can used embed favicon Shiny app HTML document.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Use Font Awesome icons as favicons — fav","text":"","code":"if (FALSE) { # interactive() html_page <- htmltools::tags$html( fav(\"earth-africa\", fill = \"blue\"), htmltools::tags$body( htmltools::tags$h1(\"Hello world!\"), htmltools::tags$p(\"(on the browser tab)\") ) ) htmltools::html_print(html_page, viewer = utils::browseURL) }"},{"path":"https://favawesome.shinyworks.org/reference/favawesome-package.html","id":null,"dir":"Reference","previous_headings":"","what":"favawesome: 'Font Awesome' Icons as 'Shiny' 'favicons' — favawesome-package","title":"favawesome: 'Font Awesome' Icons as 'Shiny' 'favicons' — favawesome-package","text":"Easily use 'Font Awesome' icons 'Shiny' 'favicons' (icons appear browser tabs). 'Font Awesome' popular set icons can used web pages. 'favawesome' provides simple way use icons 'favicons' 'Shiny' applications HTML pages.","code":""},{"path":[]},{"path":"https://favawesome.shinyworks.org/reference/favawesome-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"favawesome: 'Font Awesome' Icons as 'Shiny' 'favicons' — favawesome-package","text":"Maintainer: Jon Harmon jonthegeek@gmail.com (ORCID) [copyright holder]","code":""},{"path":"https://favawesome.shinyworks.org/news/index.html","id":"favawesome-010","dir":"Changelog","previous_headings":"","what":"favawesome 0.1.0","title":"favawesome 0.1.0","text":"Initial CRAN submission.","code":""}] +[{"path":[]},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement jonthegeek@gmail.com. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://favawesome.shinyworks.org/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to favawesome","title":"Contributing to favawesome","text":"outlines propose change favawesome.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to favawesome","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to favawesome","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to favawesome","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"shinyworks/favawesome\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to favawesome","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://favawesome.shinyworks.org/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to favawesome","text":"Please note favawesome project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://favawesome.shinyworks.org/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 favawesome authors Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with favawesome","title":"Getting help with favawesome","text":"Thanks using favawesome! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with favawesome","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with favawesome","text":"Armed reprex, next step figure ask. ’s question: ’s best ask R4DS Online Learning Community Slack. options include Posit Community, StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://favawesome.shinyworks.org/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with favawesome","text":"’ll try look issue soon can, packages maintained volunteers. good reprex particularly important might weeks months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://favawesome.shinyworks.org/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Jon Harmon. Author, maintainer, copyright holder.","code":""},{"path":"https://favawesome.shinyworks.org/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Harmon J (2024). favawesome: 'Font Awesome' Icons 'shiny' 'favicons'. R package version 0.1.0.9000, https://github.com/shinyworks/favawesome, https://favawesome.shinyworks.org.","code":"@Manual{, title = {favawesome: 'Font Awesome' Icons as 'shiny' 'favicons'}, author = {Jon Harmon}, year = {2024}, note = {R package version 0.1.0.9000, https://github.com/shinyworks/favawesome}, url = {https://favawesome.shinyworks.org}, }"},{"path":"https://favawesome.shinyworks.org/index.html","id":"favawesome-","dir":"","previous_headings":"","what":"Font Awesome Icons as shiny favicons","title":"Font Awesome Icons as shiny favicons","text":"Easily use {fontawesome} icons shiny favicons (icons appear browser tabs). Font Awesome popular set icons can used web pages. {favawesome} provides simple way use icons favicons shiny applications HTML pages.","code":""},{"path":"https://favawesome.shinyworks.org/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Font Awesome Icons as shiny favicons","text":"can install development version favawesome GitHub :","code":"# install.packages(\"pak\") pak::pak(\"shinyworks/favawesome\")"},{"path":"https://favawesome.shinyworks.org/index.html","id":"motivation","dir":"","previous_headings":"","what":"Motivation","title":"Font Awesome Icons as shiny favicons","text":"’ve spent time Chrome Developer Tools Console (ctrl + shift + ) shiny apps, may seen familiar error message: False alarms make easy miss real error messages, wanted way silence error message without adding bunch dependencies shiny app. package add dependencies already required {shiny}.","code":""},{"path":"https://favawesome.shinyworks.org/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Font Awesome Icons as shiny favicons","text":"Add call favawesome::fav() shiny UI code HTML.","code":"html_page <- htmltools::tags$html( favawesome::fav(\"earth-africa\", fill = \"blue\"), htmltools::tags$body( htmltools::tags$h1(\"Hello world!\"), htmltools::tags$p(\"(on the browser tab)\") ) ) htmltools::html_print(html_page, viewer = utils::browseURL)"},{"path":"https://favawesome.shinyworks.org/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Font Awesome Icons as shiny favicons","text":"Please note {favawesome} project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":null,"dir":"Reference","previous_headings":"","what":"Add data URI prefix to base64-encoded icon — .fav_as_href","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"Add data URI prefix base64-encoded icon","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"","code":".fav_as_href(fav_base64)"},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"fav_base64 base64-encoded character vector generated .fav_encode().","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_as_href.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add data URI prefix to base64-encoded icon — .fav_as_href","text":"base64-encoded icon data URI prefix.","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":null,"dir":"Reference","previous_headings":"","what":"Load Font Awesome icon and encode — .fav_encode","title":"Load Font Awesome icon and encode — .fav_encode","text":"Load Font Awesome icon encode","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Load Font Awesome icon and encode — .fav_encode","text":"","code":".fav_encode(name, ...)"},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Load Font Awesome icon and encode — .fav_encode","text":"name name Font Awesome icon. short name (e.g., \"npm\", \"drum\", etc.), , full name (e.g., \"fab fa-npm\", \"fas fa-drum\", etc.). names correspond current Version 6 Font Awesome names. list short full names can accessed fa_metadata() function fa_metadata()$icon_names fa_metadata()$icon_names_full. supplying previous name associated icon, internally translated current name Version 6 icon returned. ... Arguments passed fontawesome::fa fill,fill_opacity fill color icon can set fill. provided default value \"currentColor\" applied SVG fill matches color parent HTML element's color attribute. opacity level SVG fill can controlled decimal value 0 1. stroke,stroke_width,stroke_opacity stroke options allow setting color, width, opacity SVG outline stroke. default, stroke width small \"1px\" size adjustment \"stroke_width\" can useful. \"stroke_opacity\" value can decimal values 0 1 (bounds included). height,width height width style attributes rendered SVG. nothing provided height default value \"1em\" applied. width given, calculated units \"em\" basis icon's SVG \"viewBox\" dimensions. margin_left,margin_right length value margin either left right icon. default, \"auto\" used properties. space needed either side length \"0.2em\" recommended starting point. vertical_align vertical alignment icon. default, length \"-0.125em\" used. position value position style attribute. default, \"relative\" used . title option populating SVG 'title' attribute, provides -hover text icon. default, title text given icon. a11y == \"semantic\" title text automatically given rendered icon, however, providing text override . prefer_type Chooses type icon returned : (1) providing short name, (2) icon solid regular types. example, using name = \"address-book\" result two types icons Address Book. default, preference set \"regular\" option \"solid\". a11y Cases distinguish role icon inform accessibility attributes used. Icons can either \"deco\" (decorative, default case) \"sem\" (semantic). Using \"none\" result accessibility features icon.","code":""},{"path":"https://favawesome.shinyworks.org/reference/dot-fav_encode.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Load Font Awesome icon and encode — .fav_encode","text":"base64-encoded character vector representing icon png.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":null,"dir":"Reference","previous_headings":"","what":"Use Font Awesome icons as favicons — fav","title":"Use Font Awesome icons as favicons — fav","text":"Generate html necessary use Font Awesome icon favicon (icon appears browser tabs) shiny app HTML document.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use Font Awesome icons as favicons — fav","text":"","code":"fav(name, ...)"},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use Font Awesome icons as favicons — fav","text":"name name Font Awesome icon. short name (e.g., \"npm\", \"drum\", etc.), , full name (e.g., \"fab fa-npm\", \"fas fa-drum\", etc.). names correspond current Version 6 Font Awesome names. list short full names can accessed fa_metadata() function fa_metadata()$icon_names fa_metadata()$icon_names_full. supplying previous name associated icon, internally translated current name Version 6 icon returned. ... Arguments passed fontawesome::fa fill,fill_opacity fill color icon can set fill. provided default value \"currentColor\" applied SVG fill matches color parent HTML element's color attribute. opacity level SVG fill can controlled decimal value 0 1. stroke,stroke_width,stroke_opacity stroke options allow setting color, width, opacity SVG outline stroke. default, stroke width small \"1px\" size adjustment \"stroke_width\" can useful. \"stroke_opacity\" value can decimal values 0 1 (bounds included). height,width height width style attributes rendered SVG. nothing provided height default value \"1em\" applied. width given, calculated units \"em\" basis icon's SVG \"viewBox\" dimensions. margin_left,margin_right length value margin either left right icon. default, \"auto\" used properties. space needed either side length \"0.2em\" recommended starting point. vertical_align vertical alignment icon. default, length \"-0.125em\" used. position value position style attribute. default, \"relative\" used . title option populating SVG 'title' attribute, provides -hover text icon. default, title text given icon. a11y == \"semantic\" title text automatically given rendered icon, however, providing text override . prefer_type Chooses type icon returned : (1) providing short name, (2) icon solid regular types. example, using name = \"address-book\" result two types icons Address Book. default, preference set \"regular\" option \"solid\". a11y Cases distinguish role icon inform accessibility attributes used. Icons can either \"deco\" (decorative, default case) \"sem\" (semantic). Using \"none\" result accessibility features icon.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Use Font Awesome icons as favicons — fav","text":"shiny.tag (see htmltools::tag()) can used embed favicon shiny app HTML document.","code":""},{"path":"https://favawesome.shinyworks.org/reference/fav.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Use Font Awesome icons as favicons — fav","text":"","code":"if (FALSE) { # interactive() html_page <- htmltools::tags$html( fav(\"earth-africa\", fill = \"blue\"), htmltools::tags$body( htmltools::tags$h1(\"Hello world!\"), htmltools::tags$p(\"(on the browser tab)\") ) ) htmltools::html_print(html_page, viewer = utils::browseURL) }"},{"path":"https://favawesome.shinyworks.org/reference/favawesome-package.html","id":null,"dir":"Reference","previous_headings":"","what":"favawesome: 'Font Awesome' Icons as 'shiny' 'favicons' — favawesome-package","title":"favawesome: 'Font Awesome' Icons as 'shiny' 'favicons' — favawesome-package","text":"Easily use 'Font Awesome' icons 'shiny' 'favicons' (icons appear browser tabs). 'Font Awesome' (https://fontawesome.com/) popular set icons can used web pages. 'favawesome' provides simple way use icons 'favicons' 'shiny' applications HTML pages.","code":""},{"path":[]},{"path":"https://favawesome.shinyworks.org/reference/favawesome-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"favawesome: 'Font Awesome' Icons as 'shiny' 'favicons' — favawesome-package","text":"Maintainer: Jon Harmon jonthegeek@gmail.com (ORCID) [copyright holder]","code":""},{"path":"https://favawesome.shinyworks.org/reference/use_favawesome_standalone.html","id":null,"dir":"Reference","previous_headings":"","what":"Add favawesome_icon Function to a Project — use_favawesome_standalone","title":"Add favawesome_icon Function to a Project — use_favawesome_standalone","text":"import favawesome project, can still use Font Awesome (https://fontawesome.com) icon favicon (icon appears browser tabs). Calling function download necessary code add favawesome_icon() function project, ovewrite existing file already exists, making easy update code. favawesome_icon() function takes arguments fav().","code":""},{"path":"https://favawesome.shinyworks.org/reference/use_favawesome_standalone.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Add favawesome_icon Function to a Project — use_favawesome_standalone","text":"","code":"use_favawesome_standalone()"},{"path":"https://favawesome.shinyworks.org/reference/use_favawesome_standalone.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Add favawesome_icon Function to a Project — use_favawesome_standalone","text":"NULL invisibly (called side effect importing favawesome_icon() definition). favawesome_icon() returns value fav().","code":""},{"path":"https://favawesome.shinyworks.org/news/index.html","id":"favawesome-development-version","dir":"Changelog","previous_headings":"","what":"favawesome (development version)","title":"favawesome (development version)","text":"Added new function use_favawesome_standalone() allow app developers take advantage package without adding dependency package.","code":""},{"path":"https://favawesome.shinyworks.org/news/index.html","id":"favawesome-010","dir":"Changelog","previous_headings":"","what":"favawesome 0.1.0","title":"favawesome 0.1.0","text":"Initial CRAN submission.","code":""}] diff --git a/sitemap.xml b/sitemap.xml index a80afbe..5174b41 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -13,5 +13,6 @@ https://favawesome.shinyworks.org/reference/fav.html https://favawesome.shinyworks.org/reference/favawesome-package.html https://favawesome.shinyworks.org/reference/index.html +https://favawesome.shinyworks.org/reference/use_favawesome_standalone.html