docs: remove spinner + reduce load time + add rowDataMapper - PTL-1517 #2042
Conversation
|
fyi @matteematt |
There was a problem hiding this comment.
This is very useful, thanks. However to be very nitpicky, in every other doc we've created a seperate table for properties just so it's super clear to use the :
There was a problem hiding this comment.
addressed in a71d87d
| <td><code>request</code></td> | ||
| <td><code>string</code></td> | ||
| <td><code>:request</code></td> | ||
| <td><code>any</code></td> | ||
| <td>Similar to <code>fields</code> but for <a href="/develop/server-capabilities/snapshot-queries-request-server/">Request Server</a> scenarios. This optional parameter enables you to specify request fields, which can include wildcards.</td> | ||
| <td> | ||
|
|
||
| ```html |
There was a problem hiding this comment.
Now we're adding template strings I think typescript syntax works better
| ```html | |
| ```typescript |
There was a problem hiding this comment.
doesn't look good, let's stick with html (I also tried tsx which has the same output BUT in-editor it's all red/mixed with correct.. mdx + tables + code = doesn't work 100% in vscode)
docs/001_develop/03_client-capabilities/005_grids/003_grid-pro/grid-pro_02_datasources.mdx
Show resolved
Hide resolved
There was a problem hiding this comment.
Are you certain that this speed is ok? I set it to 2000 because I was testing on 1000 and sometimes it didn't load correctly?
There was a problem hiding this comment.
it never failed for me.. @matteematt can you re-check this branch? let me know if it fails
| <grid-pro-client-side-datasource resource-name="DATASERVER_OR_REQUEST_SERVER_NAME" view-number="2"> | ||
| <grid-pro-server-side-datasource resource-name="DATASERVER_OR_REQUEST_SERVER_NAME" view-number="2"> | ||
| ``` | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td><code>:rowDataMapper</code></td> | ||
| <td><code>Function</code></td> | ||
| <td>Function to map the row data before it is sent to the grid. The function should return an array of objects, where each object represents a row in the grid.</td> | ||
| <td> | ||
| ```html |
There was a problem hiding this comment.
You can add that to the properties table you created too
|
@matteematt should be ok now, had a conflict with a commit from |
|
@MrBrunoWolff @matteematt please let us know if this is approval/merge worthy |
|
Looks OK to me. The one thing which might be useful, and keen for your thoughts on... but in server for placeholders we generally use a form of brackets to denote. So instead of I realise <> doesn't work well in client docs, should we use [] ?
|
|
Maybe not, happy to be pushed back on this FYI. |
|
@jay-taylerson that sounds interesting and something that got me thinking yesterday, "wildcard scenarios" I'd leave that for a separate PR, that would scan all the pages in one go, but definitely a "next thing" |
Interesting suggstion. I think we've taken a bit of a different approach in our docs. Rather than showing a placeholder value we've tended to show concrete examples. I quite like this as I think it aids understanding for people who are new to the concept. Perhaps there are times where we are being generic though, in that case I think we should add some symbols as suggested to make it clear they're placeholders and you can't copy and paste exactly. |
This will:
:rowDataMapperattribute:requestattributeDo the changes you have made apply to both Current and Previous versions?
No
Have you done a trial build to check all new or changed links?
Yes
Is there anything else you would like us to know?
No