_pkgdown.yml

---
url: https://insightsengineering.github.io/teal

template:
  package: nesttemplate

navbar:
  structure:
    left:
      [get-started, reference, articles, blueprint, tutorials, news, reports]
    right: [search, github]
  components:
    get-started:
      text: Get started
      href: articles/getting-started-with-teal.html
    reports:
      text: Reports
      menu:
        - text: Coverage report
          href: coverage-report/
        - text: Unit test report
          href: unit-test-report/
        - text: Non-CRAN unit test report
          href: unit-test-report-non-cran/
    blueprint:
      text: Technical blueprint
      menu:
        - text: About blueprint
          href: articles/blueprint/index.html
        - text: Introduction
          href: articles/blueprint/intro.html
        - text: Actors
          href: articles/blueprint/actors.html
        - text: Data flow
          href: articles/blueprint/dataflow.html
        - text: Product map
          href: articles/blueprint/product_map.html
        - text: Features
          navbar: Features
        - text: Input data
          href: articles/blueprint/input_data.html
        - text: In-app data
          href: articles/blueprint/in_app_data.html
        - text: Filter panel
          href: articles/blueprint/filter_panel.html
        - text: Module and encapsulation
          href: articles/blueprint/module_encapsulation.html

    github:
      icon: fa-github
      aria-label: View on Github
      href: https://github.com/insightsengineering/teal

articles:
  - title: Get started
    navbar: Get started
    contents:
      - getting-started-with-teal
  - title: Using `teal`
    navbar: Using `teal`
    contents:
      - filter-panel
      - teal-options
      - bootstrap-themes-in-teal
  - title: Data in `teal` apps
    navbar: Data in `teal` apps
    contents:
      - including-data-in-teal-applications
      - data-as-shiny-module
      - data-transform-as-shiny-module
  - title: Extending `teal`
    navbar: Extending `teal`
    contents:
      - creating-custom-modules
      - adding-support-for-reporting
      - decorate-module-output
  - title: 📃 Technical blueprint
    desc: >
      The purpose of the blueprint is to aid new developer’s comprehension of the
      fundamental principles of the `teal` framework. We will explore crucial `teal`
      concepts such as data flow, actors, and filter panel, among others.
    contents:
      - blueprint/index
      - blueprint/intro
      - blueprint/actors
      - blueprint/dataflow
      - blueprint/product_map
  - title: ""
    desc: >
      Features.
    contents:
      - blueprint/input_data
      - blueprint/in_app_data
      - blueprint/filter_panel
      - blueprint/module_encapsulation

reference:
  - title: Core `teal` functions
    desc: Main functions needed to build a `teal` app
    contents:
      - init
      - teal_data_module
      - teal_transform_module
      - module_transform_data
      - make_teal_transform_server
      - module_teal_with_splash
      - module_teal
      - module
      - modules
      - teal_slices
  - title: Helper Functions
    desc: Helper functions for `teal`
    contents:
      - build_app_title
  - title: Example module
    desc: A simple `teal` module
    contents:
      - example_module
  - title: Creating reports
    contents:
      - reporter_previewer_module
      - TealReportCard
      - report_card_template
  - title: Landing popup
    contents:
      - landing_popup_module
  - title: Functions for module developers
    contents:
      - as_tdata
      - tdata
      - get_code_tdata
      - get_metadata
      - tdata2env
      - eval_code
      - within.teal_data_module
      - show_rcode_modal
      - join_keys.tdata
  - title: Validation functions
    contents:
      - starts_with("validate_")