Skip to content

Commit 54fb8c3

Browse files
committed
docs: add table of content to developer guid
1 parent 8f64863 commit 54fb8c3

File tree

1 file changed

+122
-8
lines changed

1 file changed

+122
-8
lines changed

docs/developer-guide.md

Lines changed: 122 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,128 @@ This comprehensive guide covers everything developers need to know to integrate,
44

55
## Table of Contents
66

7-
1. [Architecture Overview](#architecture-overview)
8-
2. [Installation](#installation)
9-
3. [Usage Examples](#usage-examples)
10-
4. [Configuration](#configuration)
11-
5. [API Reference](#api-reference)
12-
6. [Events](#events)
13-
7. [Plugin Development](#plugin-development)
14-
8. [Contributing](#contributing)
7+
- [YASGUI Developer Guide](#yasgui-developer-guide)
8+
- [Table of Contents](#table-of-contents)
9+
- [Architecture Overview](#architecture-overview)
10+
- [Package Structure](#package-structure)
11+
- [Architecture Diagram](#architecture-diagram)
12+
- [Package Details](#package-details)
13+
- [@matdata/yasgui-utils](#matdatayasgui-utils)
14+
- [@matdata/yasqe (SPARQL Query Editor)](#matdatayasqe-sparql-query-editor)
15+
- [@matdata/yasr (SPARQL Results Viewer)](#matdatayasr-sparql-results-viewer)
16+
- [@matdata/yasgui (Main Package)](#matdatayasgui-main-package)
17+
- [Installation](#installation)
18+
- [npm](#npm)
19+
- [Yarn](#yarn)
20+
- [CDN](#cdn)
21+
- [Source](#source)
22+
- [Usage Examples](#usage-examples)
23+
- [Plain HTML](#plain-html)
24+
- [Node.js / ES Modules](#nodejs--es-modules)
25+
- [CommonJS](#commonjs)
26+
- [React](#react)
27+
- [Vue](#vue)
28+
- [Angular](#angular)
29+
- [Using YASQE and YASR Separately](#using-yasqe-and-yasr-separately)
30+
- [Configuration](#configuration)
31+
- [YASGUI Configuration](#yasgui-configuration)
32+
- [Example Configuration](#example-configuration)
33+
- [YASQE Configuration](#yasqe-configuration)
34+
- [YASQE Example](#yasqe-example)
35+
- [Code Snippets](#code-snippets)
36+
- [YASR Configuration](#yasr-configuration)
37+
- [YASR Example](#yasr-example)
38+
- [Request Configuration](#request-configuration)
39+
- [Request Configuration Example](#request-configuration-example)
40+
- [Authentication](#authentication)
41+
- [Authentication Types](#authentication-types)
42+
- [Basic Authentication](#basic-authentication)
43+
- [Bearer Token Authentication](#bearer-token-authentication)
44+
- [API Key Authentication](#api-key-authentication)
45+
- [Managing Endpoint Configurations](#managing-endpoint-configurations)
46+
- [Dynamic Authentication](#dynamic-authentication)
47+
- [Disabling Authentication](#disabling-authentication)
48+
- [TypeScript Support](#typescript-support)
49+
- [Authentication Priority](#authentication-priority)
50+
- [Examples](#examples)
51+
- [Security Best Practices](#security-best-practices)
52+
- [Endpoint Buttons Configuration](#endpoint-buttons-configuration)
53+
- [Theme Configuration](#theme-configuration)
54+
- [API Reference](#api-reference)
55+
- [Yasgui Class](#yasgui-class)
56+
- [Constructor](#constructor)
57+
- [Methods](#methods)
58+
- [`getTab(tabId?: string): Tab | undefined`](#gettabtabid-string-tab--undefined)
59+
- [`addTab(select?: boolean, config?: PartialTabConfig): Tab`](#addtabselect-boolean-config-partialtabconfig-tab)
60+
- [`selectTabId(tabId: string): void`](#selecttabidtabid-string-void)
61+
- [`closeTab(tab: Tab): void`](#closetabtab-tab-void)
62+
- [`getTabs(): { [tabId: string]: Tab }`](#gettabs--tabid-string-tab-)
63+
- [`setTheme(theme: 'light' | 'dark'): void`](#setthemetheme-light--dark-void)
64+
- [`getTheme(): 'light' | 'dark'`](#gettheme-light--dark)
65+
- [`toggleTheme(): 'light' | 'dark'`](#toggletheme-light--dark)
66+
- [Tab Class](#tab-class)
67+
- [Methods](#methods-1)
68+
- [`getName(): string`](#getname-string)
69+
- [`setName(name: string): void`](#setnamename-string-void)
70+
- [`getId(): string`](#getid-string)
71+
- [`getYasqe(): Yasqe`](#getyasqe-yasqe)
72+
- [`getYasr(): Yasr`](#getyasr-yasr)
73+
- [`query(): Promise<void>`](#query-promisevoid)
74+
- [`setQuery(query: string): void`](#setqueryquery-string-void)
75+
- [`getQuery(): string`](#getquery-string)
76+
- [Yasqe Class](#yasqe-class)
77+
- [Methods](#methods-2)
78+
- [`getValue(): string`](#getvalue-string)
79+
- [`setValue(value: string): void`](#setvaluevalue-string-void)
80+
- [`query(): Promise<any>`](#query-promiseany)
81+
- [`abortQuery(): void`](#abortquery-void)
82+
- [`format(): void`](#format-void)
83+
- [`getPrefixes(): Prefixes`](#getprefixes-prefixes)
84+
- [`addPrefixes(prefixes: Prefixes): void`](#addprefixesprefixes-prefixes-void)
85+
- [`removePrefixes(): void`](#removeprefixes-void)
86+
- [Yasr Class](#yasr-class)
87+
- [Methods](#methods-3)
88+
- [`setResponse(response: any, duration?: number): void`](#setresponseresponse-any-duration-number-void)
89+
- [`draw(): void`](#draw-void)
90+
- [`selectPlugin(pluginName: string): void`](#selectpluginpluginname-string-void)
91+
- [`getPlugins(): { [name: string]: Plugin }`](#getplugins--name-string-plugin-)
92+
- [`download(filename?: string): void`](#downloadfilename-string-void)
93+
- [Events](#events)
94+
- [YASGUI Events](#yasgui-events)
95+
- [YASQE Events](#yasqe-events)
96+
- [YASR Events](#yasr-events)
97+
- [Event Example: Query Tracking](#event-example-query-tracking)
98+
- [Event Example: Custom Query Logging](#event-example-custom-query-logging)
99+
- [Plugin Development](#plugin-development)
100+
- [Plugin Interface](#plugin-interface)
101+
- [Step-by-Step Plugin Development Guide](#step-by-step-plugin-development-guide)
102+
- [Step 1: Create Plugin Class](#step-1-create-plugin-class)
103+
- [Step 2: Register Plugin](#step-2-register-plugin)
104+
- [Step 3: Configure Plugin](#step-3-configure-plugin)
105+
- [Step 4: Add Styling](#step-4-add-styling)
106+
- [Plugin Example: Chart Plugin](#plugin-example-chart-plugin)
107+
- [Plugin Best Practices](#plugin-best-practices)
108+
- [Theme Support for Plugins](#theme-support-for-plugins)
109+
- [Implementation Steps](#implementation-steps)
110+
- [Distributing Your Plugin](#distributing-your-plugin)
111+
- [Contributing](#contributing)
112+
- [Getting Started](#getting-started)
113+
- [Project Structure](#project-structure)
114+
- [Development Workflow](#development-workflow)
115+
- [Making Changes](#making-changes)
116+
- [Building](#building)
117+
- [Pull Requests](#pull-requests)
118+
- [Code Guidelines](#code-guidelines)
119+
- [TypeScript](#typescript)
120+
- [CSS](#css)
121+
- [Documentation](#documentation)
122+
- [Reporting Issues](#reporting-issues)
123+
- [Feature Requests](#feature-requests)
124+
- [Release Process](#release-process)
125+
- [Community](#community)
126+
- [Code of Conduct](#code-of-conduct)
127+
- [Additional Resources](#additional-resources)
128+
15129

16130
---
17131

0 commit comments

Comments
 (0)