Add documentation for component support #38656
Merged
Conversation
This file contains 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
kaspth
reviewed
Mar 5, 2020
| @@ -37,5 +37,5 @@ def self.compile | |||
| end | |||
|
|
|||
| private | |||
| attr_reader :title, :view_context | |||
| attr_reader :view_context | |||
| end | |||
There was a problem hiding this comment.
Why do we include this weighty thing in here even? Could we replace with something closer to Class.new { def render_in(view_context); "hey"; end }?
| @@ -277,6 +277,16 @@ since an attacker could use this action to access security sensitive files in yo | |||
|
|
|||
| TIP: `send_file` is often a faster and better option if a layout isn't required. | |||
|
|
|||
| #### Rendering view components | |||
There was a problem hiding this comment.
Honestly don't think this is an apt description. The support is for any object that responds to render_in, the fact that someone can implement components based on that is a side effect.
| @@ -82,8 +82,9 @@ def initialize(controller, env, defaults) | |||
| # need to call <tt>.to_json</tt> on the object you want to render. | |||
| # * <tt>:body</tt> - Renders provided text and sets content type of <tt>text/plain</tt>. | |||
| # | |||
| # If no <tt>options</tt> hash is passed or if <tt>:update</tt> is specified, the default is | |||
| # to render a partial and use the second parameter as the locals hash. | |||
| # <tt>options</tt> hash is passed or if <tt>:update</tt> is specified, the default is to either call | |||
There was a problem hiding this comment.
Looks like If no got lost. Think the wording is slightly clunky too. I think there's a version that we can write in half the length.
|
@kaspth this should be ready for another review. I couldn't get the copy to be half the length, but I feel like it's more clear 🙇 |
|
Sweet 🙌 |
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.
Summary
This PR adds some basic documentation around the support for 3rd-party component libraries introduced in #36388 and #37919.
It also includes some minor cleanups of the example components in the test suite.