Browser

Sets the browser tab's favicon at runtime, from an image the backend hands over as a data URI.

Z2UI5_CL_SMP_APP_491

Learn Browser UI5 1.71

The facts

Repository: abap2UI5/samples
Class: Z2UI5_CL_SMP_APP_491
Source file: z2ui5_cl_smp_app_491.clas.abap ↗
Category: Browser
Learning path: Reach outside the view
Minimum UI5: 1.71 — the floor abap2UI5 holds its samples to
In the playground: runs in the browser, with no system and nothing installed
Documentation: abap2ui5.github.io/docs/cookbook/browser_interaction/title ↗

Keywords: favicon, icon, tab, image, data, uri

Controls it builds

Read out of the builder chain by the abap2UI5 linter, not from the category this sample is filed under — which is what makes “which samples build one of these” a question the catalogue can answer at all.

Libraries

Run it here

The sample running, in this page — the app on its own, with no editor over it. Switch to Playground with this code

Nothing is installed and nothing is sent anywhere: the ABAP is compiled to JavaScript in this browser and runs against abap2UI5 itself.

The ABAP

z2ui5_cl_smp_app_491.clas.abap — 65 lines Read it on GitHub ↗

" @keywords favicon icon tab image data uri
" @summary Sets the browser tab's favicon at runtime, from an image the backend hands over as a data URI.
" @docs https://abap2ui5.github.io/docs/cookbook/browser_interaction/title
CLASS z2ui5_cl_smp_app_491 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    DATA favicon TYPE string VALUE `data:image/svg+xml,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 16 16'><circle cx='8' cy='8' r='7' fill='%23f60'/></svg>`.

  PROTECTED SECTION.
  PRIVATE SECTION.
ENDCLASS.


CLASS z2ui5_cl_smp_app_491 IMPLEMENTATION.

  METHOD z2ui5_if_app~main.

    IF client->check_on_navigated( ).

      DATA(view) = z2ui5_cl_ui5_view_builder=>factory(
          )->ele( n = `View` ns = `mvc`
              )->a( n = `displayBlock` v = `true`
              )->a( n = `height`       v = `100%`
              )->a( n = `xmlns`        v = `sap.m`
              )->a( n = `xmlns:mvc`    v = `sap.ui.core.mvc`
              )->a( n = `xmlns:core`   v = `sap.ui.core`
              )->a( n = `xmlns:form`   v = `sap.ui.layout.form` ).
      DATA(page) = view->ele( `Shell`
          )->ele( `Page`
              )->a( n = `title`          v = `abap2UI5 - Browser - Set the Tab Favicon`
              )->a( n = `showNavButton`  b = client->check_app_prev_stack( )
              )->a( n = `navButtonPress` v = client->_event_nav_app_leave( ) ).

      page->tag( `MessageStrip`
          )->a( n = `text`     v = `Enter an image URL (or data URI) and press the button to run the set_favicon front-end action, ` &&
                     `which updates the browser tab icon (the link rel="icon" tag) without reloading the page.`
          )->a( n = `type`     v = `Information`
          )->a( n = `showIcon` b = abap_true
          )->a( n = `class`    v = `sapUiSmallMargin` ).

      page->ele( n = `SimpleForm` ns = `form`
          )->a( n = `title`    v = `Favicon`
          )->a( n = `editable` b = abap_true
          )->ele( n = `content` ns = `form`
              )->tag( `Label`
                  )->a( n = `text` v = `favicon url`
              )->tag( `Input`
                  )->a( n = `value` v = client->_bind( favicon )
              )->tag( `Button`
                  )->a( n = `press` v = client->_event( `SET_FAVICON` )
                  )->a( n = `text`  v = `Set Favicon` ).
      client->view_display( view->stringify( ) ).

    ELSEIF client->check_on_event( `SET_FAVICON` ).

      client->follow_up_action(
          val   = z2ui5_if_client=>cs_event-set_favicon
          t_arg = VALUE #( ( favicon ) ) ).

    ENDIF.

  ENDMETHOD.
ENDCLASS.