Skip to content

Commit d4157e4

Browse files
rgaignaultrgaignault
committed
github action
1 parent f20f54d commit d4157e4

File tree

64 files changed

+486
-361
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+486
-361
lines changed

‎.github/workflows/deploy-docs.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Deploy docs on tag
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*.*.*'
7+
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: 'pages'
17+
cancel-in-progress: false
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: Check out code at tag
28+
uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0
31+
32+
- name: Setup Node.js
33+
uses: actions/setup-node@v4
34+
with:
35+
node-version: '23'
36+
cache: 'yarn'
37+
38+
- name: Install dependencies
39+
run: yarn install --immutable
40+
41+
- name: Build documentation
42+
run: yarn docs:build
43+
44+
- name: Setup Pages
45+
uses: actions/configure-pages@v4
46+
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v3
49+
with:
50+
path: './docs'
51+
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

‎docs/assets/custom.css‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
.site-menu .tsd-navigation > a[href='modules.html'] {
2+
display: none !important;
3+
}
4+
5+
.site-menu .tsd-navigation > .tsd-accordion > .tsd-accordion-summary {
6+
display: none !important;
7+
}
8+
9+
.site-menu .tsd-navigation > .tsd-accordion > .tsd-accordion-details {
10+
display: block !important;
11+
}
12+
13+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation {
14+
margin-left: 0 !important;
15+
}
16+
17+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation > li > details > summary,
18+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation > li > a {
19+
font-weight: 600;
20+
padding: 0.88rem !important;
21+
}
22+
23+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation .tsd-accordion-summary {
24+
display: flex !important;
25+
}
26+
27+
.site-menu .tsd-navigation > a[href='modules.html'] {
28+
display: none !important;
29+
}
30+
31+
.site-menu .tsd-navigation > .tsd-accordion > .tsd-accordion-summary {
32+
display: none !important;
33+
}
34+
35+
.site-menu .tsd-navigation > .tsd-accordion > .tsd-accordion-details {
36+
display: block !important;
37+
}
38+
39+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation {
40+
margin-left: 0 !important;
41+
}
42+
43+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation > li > details > summary,
44+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation > li > a {
45+
font-weight: 600;
46+
padding: 0.88rem !important;
47+
}
48+
49+
.site-menu .tsd-navigation > .tsd-accordion .tsd-nested-navigation .tsd-accordion-summary {
50+
display: flex !important;
51+
}
52+
53+
.tsd-navigation.settings {
54+
display: none !important;
55+
}
56+
57+
.tsd-filter-visibility {
58+
display: none !important;
59+
}
60+
61+
.tsd-theme-toggle {
62+
display: none !important;
63+
}
64+
65+
.tsd-panel-group.tsd-index-group {
66+
display: none;
67+
}
68+
69+
.tsd-panel.tsd-hierarchy {
70+
display: none;
71+
}

‎docs/classes/_datadog_browser-logs.Logger.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/classes/_datadog_browser-rum-react.main.ErrorBoundary.html‎

Lines changed: 5 additions & 5 deletions
Large diffs are not rendered by default.

‎docs/functions/_datadog_browser-rum-react.main.UNSTABLE_ReactComponentTracker.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@
156156
--md-sys-color-surface-container-high: #ece6eb;
157157
--md-sys-color-surface-container-highest: #e7e1e5
158158
}
159-
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Datadog Browser SDK</a><div id="tsd-toolbar-links"><a href="https://docs.datadoghq.com/">Documentation</a><a href="https://github.com/DataDog/browser-sdk">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_datadog_browser-rum-react.html">@datadog/browser-rum-react</a></li><li><a href="../modules/_datadog_browser-rum-react.main.html">main</a></li><li><a href="" aria-current="page">UNSTABLE_ReactComponentTracker</a></li></ul><h1>Function UNSTABLE_ReactComponentTracker</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unstable_reactcomponenttracker"><span class="tsd-kind-call-signature">UNSTABLE_ReactComponentTracker</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">children</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReactNode</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Element</span><a href="#unstable_reactcomponenttracker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">children</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReactNode</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DataDog/browser-sdk/blob/040e2eee0b2b4ca2d51e506d68fe74efdd8a109b/packages/rum-react/src/domain/performance/reactComponentTracker.tsx#L6">packages/rum-react/src/domain/performance/reactComponentTracker.tsx:6</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://docs.datadoghq.com/" class="tsd-nav-link">Documentation</a><a href="https://github.com/DataDog/browser-sdk" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html">Datadog Browser SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
159+
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Datadog Browser SDK</a><div id="tsd-toolbar-links"><a href="https://docs.datadoghq.com/">Documentation</a><a href="https://github.com/DataDog/browser-sdk">GitHub</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/_datadog_browser-rum-react.html">@datadog/browser-rum-react</a></li><li><a href="../modules/_datadog_browser-rum-react.main.html">main</a></li><li><a href="" aria-current="page">UNSTABLE_ReactComponentTracker</a></li></ul><h1>Function UNSTABLE_ReactComponentTracker</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unstable_reactcomponenttracker"><span class="tsd-kind-call-signature">UNSTABLE_ReactComponentTracker</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">children</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReactNode</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Element</span><a href="#unstable_reactcomponenttracker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">children</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReactNode</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Element</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DataDog/browser-sdk/blob/f20f54deb1256b3b5f3d54c7ce024b8c8f5e7f70/packages/rum-react/src/domain/performance/reactComponentTracker.tsx#L6">packages/rum-react/src/domain/performance/reactComponentTracker.tsx:6</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://docs.datadoghq.com/" class="tsd-nav-link">Documentation</a><a href="https://github.com/DataDog/browser-sdk" class="tsd-nav-link">GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html">Datadog Browser SDK</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
160160
try {
161161
const generateLinkElement = document.querySelector(".tsd-generator a");
162162
const link = document.createElement("a");

0 commit comments

Comments
 (0)