Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FED-178 Add Documentation for uiJsComponent #769

Merged
merged 1 commit into from Aug 1, 2022

Conversation

joebingham-wk
Copy link
Contributor

@joebingham-wk joebingham-wk commented Jul 13, 2022

Motivation

The process for wrapping JS components in Dart is opaque despite us having the APIs available for it to be possible. We need a document that describes the process to make it feasible for consumers to adopt the pattern.

Changes

  • Add a doc that describes wrapping JS components

Release Notes

Review

See CONTRIBUTING.md for more details on review types (+1 / QA +1 / +10) and code review process.

Please review:

QA Checklist

  • Tests were updated and provide good coverage of the changeset and other affected code
  • Manual testing was performed if needed
    • Steps from PR author:
      • Formatting is all correct
      • Links work as expected
    • Anything falling under manual testing criteria outlined in CONTRIBUTING.md

Merge Checklist

While we perform many automated checks before auto-merging, some manual checks are needed:

  • A Client Platform member has reviewed these changes
  • There are no unaddressed comments - this check can be automated if reviewers use the "Request Changes" feature
  • For release PRs - Version metadata in Rosie comment is correct

@aviary3-wk
Copy link

Security Insights

No security relevant content was detected by automated scans.

Action Items

  • Review PR for security impact; comment "security review required" if needed or unsure
  • Verify aviary.yaml coverage of security relevant code

Questions or Comments? Reach out on Slack: #support-infosec.

Copy link
Contributor

@greglittlefield-wf greglittlefield-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Final pass, this is looking super close! Awesome stuff

doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
.gitignore Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
@joebingham-wk joebingham-wk added the Hold Hold merges label Jul 28, 2022
@joebingham-wk
Copy link
Contributor Author

joebingham-wk commented Jul 28, 2022

Applied a hold because I'm going to pass this along to at least one consumer (after we're done reviewing it) to make sure it all makes sense for them!

Copy link
Contributor

@aaronlademann-wf aaronlademann-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an incredible level of detail @joebingham-wk ... nice work!

Just have a couple of suggestions.

doc/wrapping_js_components.md Show resolved Hide resolved
Copy link
Contributor

@aaronlademann-wf aaronlademann-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor

@greglittlefield-wf greglittlefield-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just spotted two more tiny things! Other than those and the image optimizations, this looks good to go!

doc/wrapping_js_components.md Outdated Show resolved Hide resolved
doc/wrapping_js_components.md Outdated Show resolved Hide resolved
Copy link
Contributor

@greglittlefield-wf greglittlefield-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Documentation looks awesome 🎉
  • No broken links

+10

Copy link

@kristinrichards-wk kristinrichards-wk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+10000
This was incredibly helpful for wrapping my JS components. The level of detail is great especially around the prop mapping for tricky types (like onChange), creating mixins for interfaces and testing. Thank you for writing this up!

@joebingham-wk joebingham-wk removed the Hold Hold merges label Aug 1, 2022
@joebingham-wk
Copy link
Contributor Author

@Workiva/release-management-p

Copy link

@rmconsole-wf rmconsole-wf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 from RM

@rmconsole2-wf rmconsole2-wf merged commit 18f49ae into master Aug 1, 2022
@rmconsole2-wf rmconsole2-wf deleted the FED-178-document-jscomponent branch August 1, 2022 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants