Repository navigation
docs: add the guides for the HTML field and React - #3
Merged
Merged
Conversation
The js repo now holds the postcode field and its React wrapper, and the spec repo defines the field and its message catalogue in version 0.3.0. The glossary of the spec gained three terms, so the local copy follows it. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
Most sites add a postcode through a form, so the field and the React wrapper need their own quickstarts. Each HTML, TSX and CSS block on these pages is a README example that the js repo runs in its CI, and a test fails when a page shows a block that no README holds. A browser test also loads each HTML example against the built element, with the mock gateway and no other host. The API reference now covers both packages, and the spec section shows the field spec. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The TSX example and the tables of props, attributes and events could drift from the packages while every test stayed green. A test now type-checks each TSX block against the built React types. Other tests compare each table with the API report of the React package and with the field spec. The HTML guide no longer repeats a claim about the release state, it names the key that the location button needs, and the README and a comment list the field page. Signed-off-by: MobileMage <aidelojejoshua@gmail.com>
The PHP package now implements spec 0.3.0, as the TypeScript packages do, so the test that every SDK of the site implements one spec version passes again. Signed-off-by: MobileMage <aidelojejoshua@gmail.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
1 participant
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.
The site gains a guide for the postcode field in a plain HTML form, a
guide for the React wrapper, the API reference of both packages, and
the field's contract as a page copied from the spec.
Each HTML example runs in a browser test against the built element.
The React example is type-checked against the wrapper's own types, and
a test compares the names in the guides' tables with the packages' API
reports, so a guide cannot drift from the code. Both guides say that
the first alpha is not published yet.
The js, php and spec pointers move to the commits that hold spec 0.3.0,
so every SDK on the site implements the same spec version.
Signed-off-by: MobileMage aidelojejoshua@gmail.com