added flags and pkgdown structure

.gitignore

@@ -24,3 +24,4 @@ vignettes/*.pdf
 ## Local locale for testing
 locale/
 locale/*
+inst/doc

DESCRIPTION

@@ -1,15 +1,27 @@
 Package: shi18ny
 Title: Tools for shiny apps internationalization
-Version: 0.0.1
-Authors@R: person("Juan Pablo", "Marin Diaz", email = "[email protected]", role = c("aut", "cre"))
-Description: Tools for shiny apps internationalization
+Version: 0.1.0
+Authors@R: 
+    person(given = "Juan Pablo",
+           family = "Marin Diaz",
+           role = c("aut", "cre"),
+           email = "[email protected]")
+Maintainer: Juan Pablo Marin Diaz <[email protected]>
+Description: Create shiny apps in multiples languages. You can include
+  common words in multiple languages or provide your custom translations.
+URL: https://github.com/datasketch/shi18ny, https://shi18ny.datasketch.dev
+BugReports: https://github.com/datasketch/shi18ny/issues
+License: MIT + file LICENSE
+LazyData: true
 Depends:
     R (>= 3.0.0),
-    yaml
 Imports:
-    shiny (>= 0.11.1),
-    shinyjs
-License: MIT
-LazyData: true
-RoxygenNote: 6.1.1
+    shiny,
+    shinyjs,
+    yaml
 Encoding: UTF-8
+Suggests: 
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr
+RoxygenNote: 7.1.0

R/i18n.R

@@ -59,7 +59,7 @@ uiLangUpdate <- function(classes, lang){
 #' @export
 availableLangs <- function(localeDir = NULL){
   x <- read.csv(system.file("ui-translations.csv", package = "shi18ny"), stringsAsFactors = FALSE)
-  names(x)[-1]
+  sort(names(x)[-1])
 }
 
 

R/input-selectImage.R

@@ -0,0 +1,92 @@
+
+
+#' Add images to dropdown options
+#'
+#' This function works only with bootstrap for now
+#'
+#' @param inputId The input slot that will be used to access the value.
+#' @param choices List of values to select from, when named the names are
+#'   appended to the right of the image.
+#' @param images List of image location that can be put in a src attribute.
+#' @param selected Selected image, defaults to first one.
+#' @param placeholder HTML to render as placeholder, overrides selected param.
+#' @param width width in of input.
+#'
+#' Borrowed from the package shinyinvoer
+#'
+selectImageInput <- function(inputId, label, choices, images = NULL,
+                             selected = 1,
+                             placeholder = NULL,
+                             width = 120) {
+
+  shiny::addResourcePath(
+    prefix='selectImage',
+    directoryPath=system.file("lib/selectImage",
+                              package='shinyinvoer')
+  )
+
+  choices_list <- lapply(seq_along(choices), function(x){
+    list(id = choices[x],
+         image = images[x],
+         label = ifelse(is.null(names(choices[x])), 0, names(choices[x]))
+    )
+  })
+
+  if(is.numeric(selected))
+    selected <- choices[selected]
+  if(is.null(placeholder)){
+    x <- choices_list[[selected]]
+    placeholder <- shiny::div(class = "selectImage", shiny::img(src=x$image), x$label)
+  }
+
+  input <- jsonlite::toJSON(choices_list, auto_unbox = TRUE)
+
+  shiny::div(
+    `data-options` = htmltools::HTML(input),
+    `data-selected` = selected,
+    id = inputId,
+    class = "dropdown",
+    style = paste0('width:', width, 'px;'),
+    label,
+    shiny::tagList(
+      shiny::singleton(
+        shiny::tags$head(
+          shiny::tags$link(rel = 'stylesheet',
+                           type = 'text/css',
+                           href = 'selectImage/selectImage.css'),
+          shiny::tags$script(src = 'selectImage/selectImage-bindings.js')
+        )
+      )
+    ),
+  )
+}
+
+#' Update select image input
+#'
+#' @param session Shiny session
+#' @param inputId The input slot that will be used to access the value.
+#' @param choices List of values to select from, when named the names are
+#'   appended to the right of the image.
+#' @param images List of image location that can be put in a src attribute.
+#' @param selected Selected image, defaults to first one.
+#' @param placeholder HTML to render as placeholder, overrides selected param.
+#' @param width width in of input.
+#'
+#' @export
+updateSelectImageInput <- function(session, inputId, label = NULL, choices = NULL,
+                                    images = NULL, selected = NULL) {
+  message <- dropNulls(
+    list(
+      label = label,
+      choices = choices,
+      images = images,
+      selected = selected)
+  )
+  session$sendInputMessage(inputId, message)
+}
+
+
+# copied from shiny since it's not exported
+dropNulls <- function(x) {
+  x[!vapply(x, is.null, FUN.VALUE=logical(1))]
+}

R/selectLangInput.R

@@ -13,95 +13,42 @@
 #' @param width width in of input.
 #'
 #' @export
-selectLangInput <- function(inputId, label, choices,
+selectLangInput <- function(inputId, label, langs,
+                            flags = NULL,
+                            show_flags = TRUE,
                             selected = 1,
                             placeholder = NULL,
-                            width = 120, img_width = 20) {
-
-  addResourcePath(
-    prefix='selectLang',
-    directoryPath=system.file("lib/selectLang",
-                              package='shi18ny')
-  )
-
-  images <- list.files(system.file("flags", package = "shi18ny"), full.names = TRUE)
-  imagesNames <- basename(file_path_sans_ext(images))
-  names(images) <- imagesNames
-  choices_list <- lapply(seq_along(choices), function(x){
-    choice <- choices[x]
-    list(id = choices[x],
-         image = paste0("data:image/svg+xml;utf8,",paste0(readLines(images[[choice]]),collapse="")),
-         label = names(choices[x])
-    )
-  })
-  names(choices_list) <- choices
-
-  if(is.numeric(selected))
-    selected <- choices[selected]
-  if(is.null(placeholder) && !is.null(choices)){
-    x <- choices_list[[selected]]
-    placeholder <- div(class = "selectLang", img(src=x$image, width = img_width), x$label)
+                            width = 100) {
+  if(show_flags){
+    flags <- flags %||% get_flags_image(langs)
   }
+  selectImageInput(inputId, label = label, choices = langs,
+                   images = flags, selected = selected, placeholder = placeholder,
+                   width = width)
 
-  l <- lapply(choices_list, function(x){
-    tags$li(class = "selectLang",
-            tags$a(href="#", title = "Select", class = "selectLang", id = x$id,
-                   img(src=x$image, width = img_width), x$label
-            )
-    )
-  })
-
-  shiny::div(
-    label,
-    shiny::div(
-      `data-shiny-input-type` = "selectLang",
-      shiny::tagList(
-        shiny::singleton(
-          shiny::tags$head(
-            shiny::tags$link(rel = 'stylesheet',
-                             type = 'text/css',
-                             href = 'selectLang/selectLang.css'),
-            shiny::tags$script(src = 'selectLang/selectLang-bindings.js')
-          ))
-      ),
-      div(class = "btn-group", id = inputId, `data-init-value` = selected,
-          tags$button(type = "button", class = "btn btn-default dropdown-toggle selectLang",
-                      style = "display: flex;align-items: center;",
-                      `data-toggle`="dropdown", `aria-haspopup`="true",  `aria-expanded`="false",
-                      div(class = "buttonInner selectLang",
-                          placeholder
-                      ),
-                      span(class="glyphicon glyphicon-chevron-down", style = "padding-left: 10px;")
-          ),
-          tags$ul( class="dropdown-menu",
-                   l
-          )
-      )
-    )
-  )
 }
 
 
-updateSelectLangInput <- function (session, inputId, label = NULL, choices = NULL, selected = NULL) {
-  # # Only updates selected for now
-  # choices <- if (!is.null(choices))
-  #   choicesWithNames(choices)
-  # if (!is.null(selected))
-  #   selected <- as.character(selected)
-  # options <- if (!is.null(choices))
-  #   selectOptions(choices, selected)
-  message <- dropNulls(
-    list(
-      label = label,
-      choices = choices,
-      selected = selected)
-  )
-  session$sendInputMessage(inputId, message)
+get_flags_image <- function(langs){
+  flags <- list.files(system.file("flags","png",package = "shi18ny"), full.names = TRUE)
+  names(flags) <- basename(tools::file_path_sans_ext(flags))
+  flags <- flags[langs]
+  image_data <- unlist(lapply(flags, function(flag){
+    knitr::image_uri(flag)
+  }))
 }
 
+#' @export
+updateSelectLangInput <- function(session, inputId, label = NULL, langs = NULL,
+                                  flags = NULL,
+                                  show_flags = TRUE,
+                                  selected = NULL){
+  if(show_flags){
+    flags <- flags %||% get_flags_image(langs)
+  }
+  updateSelectImageInput(session, inputId, label = label, choices = langs,
+                   images = flags, selected = selected)
 
-# copied from shiny since it's not exported
-dropNulls <- function(x) {
-  x[!vapply(x, is.null, FUN.VALUE=logical(1))]
 }
 
+

README.Rmd

@@ -0,0 +1,77 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+# shi18ny
+
+<!-- badges: start -->
+<!-- badges: end -->
+
+Shiny apps internationalization: same app, multiple languages.
+
+Check the full documentation at http://shi18ny.datasketch.dev
+
+
+## Installation
+
+You can install the development version from [GitHub](https://github.com/) with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("datasketch/shi18ny")
+```
+## Your first multilanguage shiny app
+
+This is a basic example which shows you how to solve a common problem:
+
+```{r example}
+#library(shi18ny)
+## basic example code
+```
+
+
+## Configuration
+
+
+
+## Add custom languages
+
+Explore more examples.
+
+
+## Roadmap
+
+- Support RTL languages properly
+- Add locale formatting for dates
+- ...
+
+
+## FAQ
+
+### My language is not yet supported, what can I do to help?
+
+File an issue and make a pull request following the instructions in the vignette.
+
+
+
+# Acknowledgements
+
+## Flags from
+
+Country Flags taken from https://github.com/hjnilsson/country-flags
+Catalonia flag from [wikipedia](https://meta.wikimedia.org/wiki/File:Flag_of_Catalonia.svg)
+
+
+
+

data-raw/DATASET.R

@@ -0,0 +1,50 @@
+library(tidyverse)
+
+# PNG flags from
+# https://github.com/gosquared/flags
+
+langs <- availableLangs()
+images <- list.files("data-raw/32", full.names = TRUE)
+
+langs_country <- tribble(
+  ~lang, ~country,
+  "ar","SA",
+  "da","DK",
+  "de","DE",
+  "en","US",
+  "es","ES",
+  "fr","FR",
+  "he","GR",
+  "hi","IN",
+  "it","IT",
+  "pt","PT",
+  "pt_BR","BR",
+  "ru","RU",
+  "sv","SE",
+  "zh_CN","CN"
+)
+# Manually add Catalonia and fallbacks (e.g. Colombia)
+
+all(langs_country$country %in% basename(file_path_sans_ext(images)))
+
+lapply(transpose(langs_country), function(x){
+  file.copy(paste0("data-raw/32/",x$country,".png"),
+            paste0("inst/flags/png/",x$lang,".png"))
+})
+
+
+### Another attempt resizing SVGs directly.
+
+# library(magick)
+# images <- list.files(system.file("flags","svg", package = "shi18ny"), full.names = TRUE)
+#
+# lapply(images, function(image){
+#   img <- image_read(image) %>% image_resize("32")
+#   path <- gsub("\\/svg","\\/png32",image)
+#   path <- gsub("\\.svg","\\.png",path)
+#   image_write(img, path, format = "png")
+# })
+
+
+
+#usethis::use_data("DATASET")