Zum Inhalt
Herunterladen
Für die eigene Seite

QuickRun einbinden

Eine Zeile lädt die Komponenten, eine zweite ist der Button. Kein Build, keine Abhängigkeit, immer die aktuelle Fassung — und ein Klick landet in QuickRuns eigenem Fenster, wo der Plan auf eine Bestätigung wartet.

Einmal einbinden

<script type="module" src="https://quickrun.org/components.js"></script>

Die Komponenten

Alles hier ist echt: die Elemente laufen auf dieser Seite und reden mit dem QuickRun auf deinem Rechner.

<quickrun-btn>

Der Button. Ein Klick öffnet QuickRuns Fenster mit dem Plan für dein Repository.

components.js wird geladen…

<quickrun-btn repo="fgilde/WebDataStudio">Starten</quickrun-btn>

<quickrun-btn run-cfg="…">

Mit einer bestimmten Config: collection, ein Pfad im Repository oder eine https-Adresse. Nie ein Befehl — QuickRun liest die Datei selbst und zeigt sie vor dem Start.

components.js wird geladen…

<quickrun-btn repo="passbolt/passbolt_api" run-cfg="collection" icon="right">Demo starten</quickrun-btn>

<quickrun-badge>

Das README-Badge als Element. Standard ist der Link auf quickrun.org; mode="run" übergibt direkt, und der Link darunter funktioniert weiterhin.

components.js wird geladen…

<quickrun-badge repo="fgilde/QuickRun" mode="run"></quickrun-badge>

<quickrun-status>

Eine Zeile: läuft QuickRun hier, und in welcher Version.

components.js wird geladen…

<quickrun-status></quickrun-status>

<quickrun-gate>

Zwei Slots, und der Ping entscheidet, welchen der Leser sieht. Damit lässt sich der Rest der Seite für einen Fall schreiben statt für beide gleichzeitig.

components.js wird geladen…

<quickrun-gate>
  <p slot="running">QuickRun ist da — ein Klick genügt.</p>
  <p slot="missing">Noch kein QuickRun? Einmal herunterladen.</p>
</quickrun-gate>

<quickrun-get>

Der Download, benannt nach dem Rechner, der die Seite liest. Immer auf unsere Download-Seite, nie direkt auf eine Datei.

components.js wird geladen…

<quickrun-get only-when-missing></quickrun-get>

<quickrun-config>

Was laufen würde, im Klartext: die quickrun.yml des Repositories oder die, die QuickRun dafür hält. Beide sind öffentlich, also kann die Seite es zeigen statt um Vertrauen zu bitten.

components.js wird geladen…

<quickrun-config repo="passbolt/passbolt_api" run-cfg="collection"></quickrun-config>

Bauen und stylen

Attribute und Farben einstellen, Vorschau ansehen, Code kopieren.

Der Button

Aussehen

Vorschau

components.js wird geladen…

Und dasselbe als Textzeile:

HTML

<script type="module" src="https://quickrun.org/components.js"></script>

<quickrun-btn>Starten</quickrun-btn>

Events

Klick den Button in der Vorschau — was dabei passiert, steht hier.

Button, Badge oder Link?

README auf GitHubdas Badge als Bild in einem Link

GitHub führt keine Skripte aus und entfernt unbekannte Link-Schemata. Bleibt Standard.

Eigene Seite<quickrun-btn>

Ein Klick öffnet direkt das Fenster, und die Seite kann auf die Events reagieren.

Link im Text, Chatquickrun.org/run?repo=…

Funktioniert überall, wo ein Link funktioniert.

Alle Attribute, Events und Sicherheitsregeln stehen in der Dokumentation: Web-Komponenten