From 8c37c20b51836fe5b14a71288ceab8552ec37752 Mon Sep 17 00:00:00 2001 From: mzayeddfe Date: Fri, 25 Oct 2024 13:25:36 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dfe-anal?= =?UTF-8?q?ytical-services/dfeshiny@e8cb976962129c1a2bb4ca71a852617bb81c35?= =?UTF-8?q?a8=20=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 | 2 +- LICENSE.html | 2 +- PULL_REQUEST_TEMPLATE.html | 2 +- articles/implementing-cookies.html | 2 +- articles/index.html | 2 +- authors.html | 12 +- index.html | 2 +- news/index.html | 12 +- pkgdown.yml | 2 +- reference/bad_link_text.html | 2 +- reference/cookies.html | 2 +- reference/cookies_banner_server.html | 2 +- reference/cookies_banner_ui.html | 2 +- reference/cookies_panel_server.html | 2 +- reference/cookies_panel_ui.html | 2 +- reference/custom_disconnect_message.html | 2 +- reference/external_link.html | 2 +- reference/index.html | 8 +- reference/init_analytics.html | 2 +- reference/init_cookies.html | 2 +- reference/section_tags.html | 149 ++++++++++++ reference/support_panel.html | 276 +++++++++++++++++++++-- reference/tidy_code.html | 2 +- search.json | 2 +- sitemap.xml | 1 + 27 files changed, 453 insertions(+), 47 deletions(-) create mode 100644 reference/section_tags.html diff --git a/404.html b/404.html index 528f524..55f1cc3 100644 --- a/404.html +++ b/404.html @@ -28,7 +28,7 @@ dfeshiny - 0.4.3 + 0.5.0 + + + + + +
+
+
+ +
+

Create a list of tags that generate a HTML section. +This generates a header using shiny::tags$h2() +and a paragraph body using shiny::tags$p()

+

This is to be used with functions in the dfeshiny package +to add extra sections to a public R Shiny dashboard in DfE

+
+ +
+

Usage

+
section_tags(heading = NULL, body, h_level = "h2")
+
+ +
+

Arguments

+ + +
heading
+

Optional - A single text string or a shiny::tagList() object +for the heading of your paragraph

+ + +
body
+

A single text string or a shiny::tagList() object +for the body of your paragraph

+ + +
h_level
+

Specify the level for your heading, if you choose to include +one.Default is "h2". Available options are "h2","h3" or "h4".

+ +
+
+

Value

+

A list of HTML tags that contain and h2 heading and a paragraph body.

+
+ + +
+

Examples

+

+# Example for text heading and body
+section_tags(
+  heading = "Heading test",
+  body = "This is a body text test"
+)
+#> <h2>Heading test</h2>
+#> <p>This is a body text test</p>
+
+# Example for using a different heading level
+section_tags(
+  heading = "Heading test",
+  body = "This is a body text test",
+  h_level = "h3"
+)
+#> <h3>Heading test</h3>
+#> <p>This is a body text test</p>
+
+
+# Example for text heading and text with other elements in the body
+
+
+section_tags(
+  heading = "Heading test",
+  body = shiny::tagList(
+    "This is a body text test. Please contact us at",
+    dfeshiny::external_link(
+      href = paste0("mailto:", "team@education.gov.uk"),
+      link_text = "team@education.gov.uk",
+      add_warning = FALSE
+    )
+  )
+)
+#> <h2>Heading test</h2>
+#> <p>
+#>   This is a body text test. Please contact us at<a href="mailto:team@education.gov.uk" target="_blank" rel="noopener noreferrer">team@education.gov.uk<span class="sr-only"> (opens in new tab)</span></a></p>
+
+
+
+
+ + +
+ + + +
+ + + + + + + diff --git a/reference/support_panel.html b/reference/support_panel.html index fd3a56e..3d82412 100644 --- a/reference/support_panel.html +++ b/reference/support_panel.html @@ -7,7 +7,7 @@ dfeshiny - 0.4.3 + 0.5.0