Add first pass at CSV docs - #72
Conversation
Deploying phlex with
|
| Latest commit: |
ba71b66
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4a1a1f14.phlex.pages.dev |
| Branch Preview URL: | https://csv-docs.phlex.pages.dev |
414f5af to
0f10a8a
Compare
0f10a8a to
117bbab
Compare
joeldrapper
left a comment
joeldrapper
left a comment
There was a problem hiding this comment.
This is great, I added a few comments.
|
|
||
| ## Introduction | ||
|
|
||
| Phlex also has a CSV table builder interface that should make you feel right at home if you're already comfortable working within Phlex. It carries over Phlex's design principles of safety, speed, and streamability. |
There was a problem hiding this comment.
I think we should talk specifically about streaming from Rails somewhere in this guide.
| column("id", user.id) | ||
| column("first_name", user.first_name) | ||
| column("last_name", user.last_name) | ||
| column("email", user.email) |
There was a problem hiding this comment.
What do you think about dropping the parentheses in this example?
| Let's take a quick look at a CSV representing an export of users. | ||
|
|
||
| ```ruby | ||
| class UserExport < ApplicationCSV |
There was a problem hiding this comment.
I wonder if we should use BaseCSV to be more consistent with how we name the base component.
|
|
||
| ```ruby | ||
| class ApplicationCSV < Phlex::CSV | ||
| def trim_whitespace? = true |
There was a problem hiding this comment.
Do you think we should rename this to strip_whitespace to be consistent with Ruby’s method?
| ::: code-group | ||
| ```ruby | ||
| class UserExport < ApplicationCSV | ||
| def render_headers? = false |
There was a problem hiding this comment.
Perhaps here or in the section below about the initializer, we should highlight that you could pass this in as an option if you wanted define a method that points to an ivar.
2 participants
I refer exclusively to
row_templatewhich is not yet supported, so that needs to get added before we can show these docs off.I also added a markdown footnotes plugin.