Repository navigation
docs: rewrite readme and examples for 1.0 - #5
Merged
Merged
Conversation
A parent navigation item with an own question got hasValue: true as soon as it had a child, even if no question had an answer. hasValue is now true only if the parent or one of its children has a value. Also move the restore-state example into its own folder. BREAKING CHANGE: hasValue of parent navigation items is false until the parent or one of its children has an answer. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- restructure readme: getting started, guides, api table - document component types, dependent options, navigation output, validation, NO_VALUE, jumping to questions and restoring state - fix wrong code samples and broken links - explain every example and link its data and tests - add navigation example with tests - fix misleading comments about always possible follow up questions - replace outdated next branch in contributing guide Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
What is accomplished by your PR?
README
value,active,hasValue,isValid, …)NO_VALUEdefaultValueis not saved automaticallynextItemId: {},onSubmit(value: any)in a JS block), typos,/tree/link to a file,masterlink, line-number link totypes.tsExamples
data.tsand the speccustom-component-typesandextending-data-definitionlist every override and whynavigation(categories with and without own question, jumping, changing answers) with 4 testsrestore-statemoved into its own folder with a READMEFix (separate commit, breaking)
hasValueof a parent navigation item with its own question wastrueas soon as it had a child, even without any answer. It is nowtrueonly when the parent or a child has an answer.Other
_alwaysPossibleFollowUpQuestionComponents(it checks the component type of the question itself)CONTRIBUTING.md: replaced the outdatednextbranch withmainIs there something controversial in your PR?
hasValuefix is a breaking change (planned for 1.0).Checklist
🤖 Generated with Claude Code