Repository navigation
docs(sdk): add guide to custom components - #12
Merged
Merged
Conversation
fortuna
marked this pull request as draft
October 13, 2026 17:30
Deploying outline-developer-documentation with
|
| Latest commit: |
40222a5
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://97ac8616.outline-developer-documentation.pages.dev |
| Branch Preview URL: | https://docs-extend-configurl.outline-developer-documentation.pages.dev |
fortuna
marked this pull request as ready for review
October 13, 2026 20:16
ohnorobo
approved these changes
Oct 14, 2026
ohnorobo
left a comment
Contributor
There was a problem hiding this comment.
nice, thanks for adding this!
angelodlfrtr
approved these changes
Oct 14, 2026
angelodlfrtr
left a comment
Contributor
There was a problem hiding this comment.
Unless comments I made it is nice! Publishing the full code in a repo with the variants could be helpful too as a starting point for readers / implementers.
added 6 commits
October 14, 2026 17:34
This reverts commit 0ffab1a.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add “Adding Custom Components” under the “Custom Components” SDK sidebar entry. The guide shows component authors how to publish a Go library in their own repository with direct constructors and
Register*helpers; consuming apps import the library and register on their own configurl provider container.The runnable example separates
components/delay.go,components/timeout.go, and the consuming app'smain.go. Constructors own the behavior and validation, while registration helpers parsedelay:<time>andtimeout:t=<time>&error=<msg>. A direct-use helper demonstrates constructing the same stack without configuration strings. The guide also covers wrapper order, encoding, registration scope, and links to the key extension APIs.Validation:
git diff --checkpassed.The optional TypeScript check has three existing
Cannot find namespace 'JSX'errors insrc/pages/index.tsx(lines 7, 27, 75), previously reproduced on the unchanged base revision.Phase 1 of the configuration extension documentation project. SmartDialerOptions API changes and the Mobileproxy extension article remain separate follow-up phases.