docs

ViewComponent · Mar 28, 2023 · 2632bdf · 2632bdf
1 parent 4e290d5
commit 2632bdf
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -24,6 +24,10 @@ nav_order: 5
 
     *Cameron Dutro*
 
+* Document lack of support for request formats.
+
+    *Jared Moody, Joel Hawksley*
+
 ## v3.0.0.rc4
 
 Run into an issue with this release candidate? [Let us know](https://github.com/ViewComponent/view_component/issues/1629).

diff --git a/docs/known_issues.md b/docs/known_issues.md
@@ -6,6 +6,8 @@ nav_order: 9
 
 # Known issues
 
+_Want to help address these issues? PRs are welcome!_
+
 ## turbo_frame_tag double rendering or scrambled HTML structure
 
 When using `turbo_frame_tag` inside a ViewComponent, the template may be rendered twice. See [https://github.com/github/view_component/issues/1099](https://github.com/github/view_component/issues/1099).
@@ -43,3 +45,7 @@ Calls to form helpers such as `form_with` in ViewComponents [don't use the defau
 ## Inconsistent controller rendering behavior between Rails versions
 
 In versions of Rails < 6.1, rendering a ViewComponent from a controller doesn't include the layout.
+
+## Lack of support for request formats
+
+ViewComponents only support rendering HTML.
diff --git a/test/sandbox/test/request_formats_test.rb b/test/sandbox/test/request_formats_test.rb
@@ -2,13 +2,17 @@
 
 class RequestFormatsTest < ActionDispatch::IntegrationTest
   def test_rendering_component_with_multiple_formats
+    skip
+
     get "/request_formats"
     assert_response :success
 
     assert_select("p", "Hello, HTML World")
   end
 
   def test_rendering_text_format
+    skip
+
     get "/request_formats.txt"
     assert_response :success