Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #1630

Closed
KES777 opened this issue Dec 7, 2018 · 82 comments
Closed

Improve documentation #1630

KES777 opened this issue Dec 7, 2018 · 82 comments

Comments

@KES777
Copy link

KES777 commented Dec 7, 2018

This section says:

In order for the virtual DOM to function correctly you must ensure that the table element has a height you can either define this in the CSS for the element or set it using the height option in the table constructor, this can be set to any valid CSS value. If no height is set the table will revert to the standard DOM mode and try and render all rows at once, which will have a performance impact on tables with a large number of rows.

But here virtualDOM option does not mention this.
Probably you should put link from here to the paragraph above

You should put a note about the true is falling back to false when table has no height

@KES777
Copy link
Author

KES777 commented Dec 7, 2018

Also typo here

resize the columns to fit thier data,

their

@KES777
Copy link
Author

KES777 commented Dec 7, 2018

Another typo here

Disabling the Virtual DOM
f you need to disable virtual rendering

if

@KES777
Copy link
Author

KES777 commented Dec 7, 2018

Links on the page are broken:

The function accepts one argument, the CellComponent for the cell the tooltip is being generated for.

The function accepts one argument, the RowComponent for the row being formatted.

CellComponent/RowComponent

@KES777
Copy link
Author

KES777 commented Dec 7, 2018

Typo

Get Element
The getElement function returns the DOM node for the gruop header.

group

@KES777
Copy link
Author

KES777 commented Dec 7, 2018

Typo

Any function that takes a component as an argument will also attempt to find that component based on the value provided if it is not a component iteslf

itself

@KES777
Copy link
Author

KES777 commented Dec 8, 2018

Typo

To specify a sorter to be used on a column use the param property in the columns definition object

param -> sorter

@KES777
Copy link
Author

KES777 commented Dec 8, 2018

Would be cool if Tabulator will support ability to change default value of headerSort property
here

	var table = new Tabulator("#example-table", {
		height      : "25rem",
		headerSort  : false, <<< disabled by default
		columns: [
			{ title: "",   field: "" },  <<< disabled
			{ title: "",   field: "" },  <<< disabled
			{ title: "",   field: "" },  <<< disabled
			{ title: "",   field: "", headerSort: true },   <<< enable
		],
	});

this would be much clear than:

	var table = new Tabulator("#example-table", {
		height      : "25rem",
		columns: [
			{ title: "",   field: "", headerSort: false },  <<< disabled
			{ title: "",   field: "", headerSort: false },  <<< disabled
			{ title: "",   field: "", headerSort: false },  <<< disabled
			{ title: "",   field: "" },   <<< enable
		],
	});

@olifolkerd
Copy link
Owner

Hey @KES777

Thanks for heads up on the typos, they should all be fixed now.

Thanks for your feedback on the headerSort property, but im going to keep it where it is for the time being. There are lots of users who want to disable sort on a per column basis.

Cheers

Oli :)

@KES777
Copy link
Author

KES777 commented Dec 8, 2018

but im going to keep it where it is for the time being.

I am not asking to change things. Just extend the behavior by allowing to change default value. Look into example more precisely ;-)

@KES777
Copy link
Author

KES777 commented Dec 8, 2018

if you are not afraid I will continue to post issues about the DOC here.

improve

your example shows table with data, but source code do not show how data are fetched into table.
Another examples also hide this fact. ;)

UPD this is covered only here.

@olifolkerd
Copy link
Owner

@KES777

Please feel free to post any other issues you notice here.

Cheers

Oli :)

@KES777
Copy link
Author

KES777 commented Dec 8, 2018

ambiguous

Change the Header Formatter
You can use the setGroupHeader function to change the header generation function for each group. This function has one argument and takes the same values as passed to the groupHeader setup option.

The groupHeader returns string to represent the group value, but here you return bool.
possibly the example should belongs to Change the Start Open States section

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

Typo

The getIndex function returns the index value for the row. (this is the value from the defined index column, NOT the ros position in the table)

ros -> pos? row?

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

Typo

Navigation
You can navigat any direction around the table using the following functions:

navigate

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

improve

probably you should put a word about that navPrev is an action.

and use this action name when you extend keybindings actions:

Tabulator.prototype.extendModule("keybindings", "bindings", {
    customActionName:"shift + 9",         // <<<< NOTICE HERE
});

The default list of keybinding actions and their functions can be extended:

Tabulator.prototype.extendModule("keybindings", "actions", {
    "customActionName":function(){ //delete selected rows      <<<<  NOTICE HERE
        var rows = this.table.getSelectedRows();

        rows.forEach(function(row){
            row.delete();
        });
    },
});

Also put a word: if you use already existing action name that action will be replaced. Thus you can change behavior of default actions

because http://tabulator.info/docs/4.1/keybindings does not show how to setup custom action's handler.

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

Typo

so that a users preferences can be remembered

a user preferences or users preferences ("a" may not be used with plurals, but I may wrong)

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

Typo

Both options can take either an html string representing the contents of the toggl element

toggle

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

would be cool if you allow to copy links to paragraph like this:

__
https://metacpan.org/pod/Mojolicious#before_routes

__

https://mojolicious.org/perldoc#CONVENTIONS

@KES777
Copy link
Author

KES777 commented Dec 10, 2018

Typo

tree events on that that row.

that that -> that

@KES777
Copy link
Author

KES777 commented Dec 11, 2018

ambiguous at row formatter example:

    rowFormatter:function(row, data){
        var element = row.getElement(),
        data = row.getData(),    
        width = element.element.offsetWidth,

if you get data as function argument why you define data again?

@KES777
Copy link
Author

KES777 commented Dec 11, 2018

Typo

buttonTick - displays a tick icon on eac row (for use as a button)
buttonCross - displays a cross icon on eac row (for use as a button)

each

@KES777
Copy link
Author

KES777 commented Dec 11, 2018

Typo

If you want to disabled

to disable

@KES777
Copy link
Author

KES777 commented Dec 12, 2018

Typo

You can also load data at any point by ajxa

ajax

Also here:

If you have already set the URL using the ajaxURL option in the table constructor then you can trigger a reload of the data at any point by calling the setData function without any arguments.
table.setData();

May you please to explicitly name this as: Refresh/Reload section. It would be more handy. thank you.

@KES777
Copy link
Author

KES777 commented Dec 12, 2018

This is not clear what is top and bottom calculations: http://tabulator.info/docs/4.1/column-calcs#format http://tabulator.info/docs/4.1/format

Please put appropriate links which describe what is topCalcFormatterParams and bottomCalcFormatterParams

@KES777
Copy link
Author

KES777 commented Dec 12, 2018

I have found that it is hard to find where formatters are documented: http://tabulator.info/docs/4.1/format#format-builtin
because section name List lookup do not correspond the formatter.

As proposition you may list formatters at the contents as subsection

__

Repository owner deleted a comment from KES777 Dec 12, 2018
Repository owner deleted a comment from KES777 Dec 12, 2018
@KES777
Copy link
Author

KES777 commented Apr 13, 2019

code have comment:

//register table for inderdevice communication

this is typo for inderdevice

@KES777
Copy link
Author

KES777 commented Jun 10, 2019

tabulator.info/docs/4.2/group#setup-toggle

To then set the default open

@KES777
Copy link
Author

KES777 commented Jun 10, 2019

The example speaks about different things:

_

https://tabulator.info/docs/4.2/group

HeaderFormatter should return the display string instead of boolean value

@KES777
Copy link
Author

KES777 commented Jun 11, 2019

_

Menu link is not clickable http://tabulator.info/docs/4.2/group#multi

@KES777
Copy link
Author

KES777 commented Jun 11, 2019

Documentation missed info about forth parameter:

_

http://tabulator.info/docs/4.2/group#multi

compare description with one level grouping (two paragraph earlier)
_

@KES777
Copy link
Author

KES777 commented Jul 24, 2019

http://tabulator.info/docs/4.3/release

allow users to cleare the cells value easily.

should be clear

"undefined" text no longer appears when am undefined value is passed into a textarea editor

am??

@KES777
Copy link
Author

KES777 commented Jan 28, 2020

At section Update or Add Data:

If the data you are passng to the table

passing

@KES777
Copy link
Author

KES777 commented Jan 28, 2020

On page links to Row component are broken: http://tabulator.info/docs/4.5/update#component-row

@KES777
Copy link
Author

KES777 commented Apr 4, 2020

Please describe the format of an item

http://tabulator.info/docs/4.6/edit#edit-builtin

image

@KES777
Copy link
Author

KES777 commented May 27, 2020

http://tabulator.info/docs/4.6/reactivity#reactive-data

Typo: Replacing Entier Data Array -> Replacing Entir Data Array

On same page too:

tabledata.push(row); -> tableData.push( row )

@olifolkerd Hi, Oli. Does this issue alive? Are my posts here useful?

@KES777
Copy link
Author

KES777 commented Jun 5, 2020

image

Please update documentation on this page http://tabulator.info/docs/4.6/edit#edit

image

@olifolkerd
Copy link
Owner

Hey @KES777

Thanks for those, yes it is still helpful when you post the feedback on here.

Cheers

Oli :)

@KES777
Copy link
Author

KES777 commented Jun 8, 2020

Probably I am not english speaker. But these two description seems similar to me:

image

Probably this should be reworded to be more explicit

@KES777
Copy link
Author

KES777 commented Jun 14, 2021

http://tabulator.info/docs/4.9/edit

If you want to generate the options when the select editor is triggered, then you can pass a function into the editorParams, that must return the option list in one of the two formats outlined above

above aoutlined six formats. Which two of them you mean?

probably you mean any

@KES777
Copy link
Author

KES777 commented Jun 15, 2021

@KES777
Copy link
Author

KES777 commented Aug 31, 2021

image

row? It seems I do not understand this. Or just misread (

@KES777
Copy link
Author

KES777 commented Mar 3, 2023

https://tabulator.info/docs/5.4/jquery#overview
image

It would be better, to my mind put links to CDN *.js files. or provide examples how to include those. Similarly to https://tabulator.info/docs/5.4/jquery#overview-install

Thank you.

@olifolkerd
Copy link
Owner

Thanks for the feedback.

In this case I'm gonna disagree. With jQuery there are many ways to include it in the project and it is up to the developer to decide what is best for them.

Also especially with jQuery, it is not a case of using Tabulator means you need to include jQuery, it is a case of you are already using jQuery and you want to add tabulator so it will already be setup in your project.

The links to each of the third party docs include instructions on how to set them up

Cheers

Oli

@KES777
Copy link
Author

KES777 commented Mar 5, 2023

Yep, agree. But it is still better to provide link to that part of documentation where developer could choose how to connect that library, instead of link to main page of jQuery.
image

@KES777
Copy link
Author

KES777 commented Apr 7, 2023

Thank you, Oli, for your great Tabulator. I found some typos in the documentations. It would be nice if you fix them.

https://tabulator.info/examples/5.4?#editable
image

@KES777
Copy link
Author

KES777 commented Apr 7, 2023

Link does not work:
image

@KES777
Copy link
Author

KES777 commented Apr 7, 2023

https://tabulator.info/docs/5.4/columns#definition
image

But in this example:
https://tabulator.info/examples/5.4?#movable

those fields are not used to define column with row handles:
image

Please fix documentation about requirements.

Personally I often used columns without titles for columns with IDs:
image

@KES777
Copy link
Author

KES777 commented Apr 7, 2023

https://tabulator.info/examples/5.4?#movable-between-tables

This example does not work in FireFox

@KES777
Copy link
Author

KES777 commented Apr 7, 2023

Seems loading never ends:
image

@KES777
Copy link
Author

KES777 commented Apr 7, 2023

https://tabulator.info/docs/5.4/data#ajax-sort

It is not clear what column:column means

image

@KES777
Copy link
Author

KES777 commented Apr 29, 2023

https://tabulator.info/docs/5.4/select#overview

Holding down the shift key and click dragging over a number of rows to toggle the state of all rows the cursor passes over.

Please put a note that this feature does not work on FF.

@KES777
Copy link
Author

KES777 commented May 8, 2023

Small typos. Missed " for second key/value:
image

https://tabulator.info/docs/5.4/format#formatter-lookup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants