Merge pull request #535 from pfitaxel/feedback

Add feedback button with internationalized tooltip Close #525
ocaml-sf · Apr 18, 2023 · 8878c9b · 8878c9b
2 parents af83c70 + 6b7b226
commit 8878c9b
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 3 deletions.
diff --git a/src/app/learnocaml_index_main.ml b/src/app/learnocaml_index_main.ml
@@ -642,8 +642,9 @@ let set_string_translations () =
   List.iter
     (fun (el, text) ->
        (Tyxml_js.To_dom.of_input el)##.placeholder := Js.string text)
-    placeholder_translations
-
+    placeholder_translations;
+  Manip.SetHTMLElement.title (find_component "learnocaml-main-feedback")
+    [%i"Send feedback to Learn-OCaml developers"]
 
 let () =
   Lwt.async_exception_hook := begin fun e ->

diff --git a/src/utils/js_utils.ml b/src/utils/js_utils.ml
@@ -455,6 +455,18 @@ module Manip = struct
       elt##.oninput := (bool_cb f)
   end
 
+  module HTMLElement = struct
+    let title elt =
+      let elt = get_elt "HTMLElement.title" elt in
+      Js.to_string (elt##.title)
+  end
+
+  module SetHTMLElement = struct
+    let title elt v =
+      let elt = get_elt "HTMLElement.title" elt in
+      elt##.title := Js.string v
+  end
+
   module Attr = struct
     let clientWidth elt =
       let elt = get_elt "Attr.clientWidth" elt in

diff --git a/src/utils/js_utils.mli b/src/utils/js_utils.mli
@@ -118,6 +118,16 @@ module Manip : sig
     val oninput: ('a,Dom_html.event) ev
   end
 
+  (** Read the properties of DOM elements. *)
+  module HTMLElement : sig
+    val title: 'a elt -> string
+  end
+
+  (** Modify the properties of DOM elements. *)
+  module SetHTMLElement : sig
+    val title: 'a elt -> string -> unit
+  end
+
   module Attr : sig
     val clientWidth: 'a elt -> int
     val clientHeight: 'a elt -> int

diff --git a/static/css/learnocaml_main.css b/static/css/learnocaml_main.css
@@ -169,6 +169,20 @@ body {
 
 /* Large screen: two columns w/ menu in the left column */
 @media (min-width: 1000px) {
+  #learnocaml-main-toolbar a.btn {
+    margin-left: 17px;
+  }
+
+  #learnocaml-main-toolbar a.btn > img {
+    border: 1px #fff solid;
+    background: linear-gradient(to bottom, #bbb 0%, #888 100%);
+    border-radius: 5px;
+    padding: 5px;
+    width: 18px;
+    box-shadow: 0 0 10px 2px rgba(0,0,0,0.4);
+    text-align: center;
+  }
+
   #learnocaml-main-toolbar {
     position: absolute;
     left: 0; top: 0; height: 60px; width: 360px;
@@ -181,6 +195,7 @@ body {
   #learnocaml-main-toolbar > button {
     display: none;
   }
+
   #learnocaml-main-toolbar::before {
     z-index: 1004;
     position: absolute;
@@ -215,6 +230,21 @@ body {
 }
 /* Medium screen: one column w/ popup menu */
 @media (max-width: 999px) {
+  #learnocaml-main-toolbar a.btn {
+    margin-left: 10px;
+  }
+
+  #learnocaml-main-toolbar a.btn > img {
+    border: 1px #fff solid;
+    background: linear-gradient(to bottom, #bbb 0%, #888 100%);
+    color: #fff;
+    border-radius: 5px;
+    padding: 5px;
+    width: 18px;
+    box-shadow: 0 0 10px 2px rgba(0,0,0,0.4);
+    text-align: center;
+  }
+
   #learnocaml-main-toolbar {
     position: absolute;
     top: 0; left: 0px; right: 0px;
@@ -233,6 +263,7 @@ body {
     position: relative;
     display: block;
   }
+
   #learnocaml-main-toolbar > button > * {
     padding: 5px;
     color: #eee;
@@ -280,6 +311,17 @@ body {
 }
 /* Small screen: no button labels, thinner bars & buttons */
 @media (max-width: 549px) {
+  #learnocaml-main-toolbar a.btn > img {
+    border: 1px #fff solid;
+    background: linear-gradient(to bottom, #bbb 0%, #888 100%);
+    color: #fff;
+    border-radius: 4px;
+    padding: 3px;
+    width: 13px;
+    box-shadow: 0 0 10px 2px rgba(0,0,0,0.4);
+    text-align: center;
+  }
+
   #learnocaml-main-panel,
   #learnocaml-main-content {
     top: 40px;

diff --git a/static/icons/icon_feedback.svg b/static/icons/icon_feedback.svg
diff --git a/static/index.html b/static/index.html
@@ -25,6 +25,9 @@
       <div class="logo">
         <img src="/icons/logo_ocsf.svg">
         <span>Learn OCaml</span>
+        <a class="btn" href="https://github.com/learn-ocaml-community/teaching-feedback#readme" target = "_blank">
+          <img id="learnocaml-main-feedback" title="Send Feedback" src="/icons/icon_feedback.svg">
+        </a>
       </div>
     </div>
     <div id="learnocaml-main-panel" class="hidden">

diff --git a/translations/fr.po b/translations/fr.po
@@ -6,7 +6,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: learn-ocaml ~dev\n"
-"PO-Revision-Date: 2022-12-29 00:17+0100\n"
+"PO-Revision-Date: 2023-04-18 19:58+0200\n"
 "Last-Translator: Erik Martin-Dorel <[email protected]>\n"
 "Language-Team: OCSF\n"
 "Language: french\n"
@@ -523,6 +523,10 @@ msgstr "Vous avez déjà un token ? Par ici !"
 msgid "Connect"
 msgstr "Se connecter"
 
+#: File "src/app/learnocaml_index_main.ml", line 631, characters 35-50
+msgid "Send feedback to Learn-OCaml developers"
+msgstr "Envoyer un commentaire aux développeurs Learn-OCaml"
+
 #: File "src/app/learnocaml_index_main.ml", line 638, characters 9-19 640,
 #: "src/app/learnocaml_teacher_tab.ml", 558, 22-32
 msgid "Nickname"
@@ -1084,3 +1088,4 @@ msgstr "Erreur inattendue:\n"
 
 #~ msgid "This session has been closed. You can close this tab."
 #~ msgstr "La session a été fermée. Vous pouvez fermer cet onglet."
+