[guides] Finalize Guides for v2.0.0-beta.1 by pzuraq · Pull Request #549 · Addepar/ember-table

pzuraq · 2018-06-15T16:52:33Z

This PR updates the docs app for the first beta of v2. Changes include:

Converting all curly bracket invocations to angle brackets
Adding missing guides pages
Adding API docs
Shifting examples -> guides (better terminology)
Adding/updating intro and landing pages

There is also one minor behavioral change, we've dropped the CellProxy
construct. In writing the guides it became apparent that it was leaky,
and the perf benefits are questionable. For now, cell metas are POJOs.

This PR updates the docs app for the first beta of v2. Changes include: - Converting all curly bracket invocations to angle brackets - Adding missing guides pages - Adding API docs - Shifting examples -> guides (better terminology) - Adding/updating intro and landing pages There is also one minor behavioral change, we've dropped the `CellProxy` construct. In writing the guides it became apparent that it was leaky, and the perf benefits are questionable. For now, cell metas are POJOs.

cyril-sf · 2018-06-15T21:44:34Z

-  destroy() {
-    this._cellMeta.destroy();
+    if (!cellMetaCache.has(cellId)) {
+      cellMetaCache.set(cellId, EmberObject.create());


do we ever teardown the cache properly?

Yes, this is torn down by the owner which is the tbody.

https://github.com/Addepar/ember-table/blob/master/addon/components/ember-tbody/component.js#L249-L256

my C++ days make me always worried to not see a corresponding destroy to a create

cyril-sf · 2018-06-15T21:59:45Z

+  ```
+
+  @yield {any} cellValue - The value of the cell
+  @yield {object} columnValue - The column definition


was there discussions to use columnDefinition instead of columnValue?

I don't think we ever discussed it. I would be open to that, but I'd like to get this published first and come back to it if we find it's unintuitive.

that's fine.

cyril-sf · 2018-06-15T22:17:05Z

+        columnMeta=api.columnMeta

-        cell=(component "ember-th" api=cell)
+        enableResize=api.enableResize


some options here do not seem documented

Yes, that was intentional. Parts of the API are public, and parts aren't really and are just for communication. In the future ideally we will figure out a way to make these more genuinely private.

cyril-sf · 2018-06-15T22:38:26Z

+related to a particular cell, column, or row. A good example of this is cell
+selection, like in Excel.
+
+When you click a cell in excel, the row, column, and cell are all marked as


cyril-sf · 2018-06-15T22:40:21Z

+</div>

-An addon to support large data set and a number of features around table. Ember Table can handle over 100,000 rows without and rendering or performance issue. This version of Ember Table supports Ember 1.11 to latest version of Ember.
+Ember Table is a power table made for users who need a full-fledged,


are we not too "elitist" here? it seems like that it works pretty well out of the box, no?

Not sure what you mean exactly here, can you clarify?

By reading this paragraph, I have a feeling that Ember Table wouldn't be a great fit for people wanting a simple table.

cyril-sf · 2018-06-15T22:43:03Z

-  })
+  rows = [
+    {
+      firstName: 'Cyril',


Is this a test to see if I'm doing the code review diligently? 😄

we can find a better example 😉

lol, I just needed a first name. If you want me to change it I can, no worries

cyril-sf · 2018-06-15T22:43:48Z

-`column`. To customize table header or footer, you can pass in `headerComponent` and
-`footerComponent` fields in each column data. When the `headerComponent`(or `footerComponent`) is
-defined, the `name`(or `footerValue`) field is ignored.
+And viola! You should have a basic table up and running!


voila 🇫🇷

cyril-sf · 2018-06-15T22:44:52Z

+
+Building that functionality into your Single Page App is a long, tiresome
+process, and as the datasets scale it just gets harder. There are a lot of
+different off the shelf tables out there, like ag-grid and HandsOnTable, but


not sure if we want to reference other tables.

I can remove the references. Mainly wanted to highlight the differences, and why we're better for many use cases.

My main concern is that I don't know if this could feel outdated each time someone else try to publish a new addon.

pzuraq force-pushed the pzuraq/guides/finalize-guides-for-beta-1 branch from aae30f9 to fb5b3a8 Compare June 15, 2018 17:51

pzuraq force-pushed the pzuraq/guides/finalize-guides-for-beta-1 branch from fb5b3a8 to 674300c Compare June 15, 2018 18:10

add section on usage without angle brackets

b844a7a

cyril-sf reviewed Jun 15, 2018

View reviewed changes

pzuraq added 2 commits June 15, 2018 16:09

address comments

930ef1d

fix data test selector

5165279

pzuraq force-pushed the pzuraq/guides/finalize-guides-for-beta-1 branch from 0a63b77 to 5165279 Compare June 16, 2018 00:17

pzuraq merged commit 4cd1330 into master Jun 16, 2018

pzuraq deleted the pzuraq/guides/finalize-guides-for-beta-1 branch June 16, 2018 00:50

Conversation

pzuraq commented Jun 15, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants