deblan-mirror/TableFilter
1
0
Fork 0
mirror of https://github.com/koalyptus/TableFilter.git synced 2024-05-03 07:03:33 +02:00
Code Issues Releases Wiki Activity
Page: 1.13 Help instructions
Pages
1.0 Configuration 1.01 Appearance 1.02 Main features 1.03 Grid layout 1.04 Paging 1.05 Drop down filter 1.06 Checklist filter 1.07 Rows counter 1.08 Loading indicator 1.09 Submit and reset button 1.10 Status bar 1.11 Data types 1.12 Themes 1.13 Help instructions 1.14 Popup filters 1.15 No results message 1.16 Highlight keywords 1.17 State 1.18 Mark active columns 1.19 Toolbar 1.20 Single filter 2.0 TableFilter class 2.1 Public properties 2.2 Public methods 3.0 Extensions 3.1 Advanced grid 3.1 Sort 3.2 Column operations 3.3 Filters visibility 3.4 Columns visibility 4. Filter operators Home Obsolete TODO
7 1.13 Help instructions
koalyptus edited this page 2020-05-14 12:56:01 +10:00

Container displaying help instructions.

Property Type Description Remarks Example
help_instructions boolean|object

enables / disables question mark visibility showing help container element (default - undefined)

 Note that the help feature is generated automatically unless you set this property to false 
var tfConfig = { help_instructions: true };
// or
var tfConfig = { 
  help_instructions: {} 
};
target_id string defines the id of the element containing the instructions button (?) (default - null) By default the ? is generated in the top toolbar 
var tfConfig = { 
  help_instructions: {
    target_id: 'myContainerId'
  } 
};
container_target_id string defines the id of the container element for instructions content (default - null) 
var tfConfig = { 
  help_instructions: {
    container_target_id: 'myContainerId'
  } 
};
text string sets the help/instructions text (default - 'Use the filters above each column to filter and limit table data.') 
var tfConfig = { 
  help_instructions: {
    text: 'My Help text here...'
  } 
};
html string sets the help/instructions HTML (default - null) 
var tfConfig = { 
  help_instructions: {
    html: '
My Help text here...
Hello world!
'
  } 
};
btn_text string sets the help/instructions button text (default - '?') 
var tfConfig = { 
  help_instructions: {
    btn_text: 'Help'
  } 
};
btn_html string sets the help/instructions button HTML (default - '?') Note that the onclick event is added by default to the html element and overwrites any eventual onclick attribute 
var tfConfig = { 
  help_instructions: {
    btn_html: ''
  } 
};
btn_css_class string defines the css class of the help/instructions button (default - 'helpBtn') 
var tfConfig = { 
  help_instructions: {
    btn_css_class: 'myCssClass'
  } 
};
container_css_class string defines the css class of the help/instructions container (default - 'helpCont') 
var tfConfig = { 
  help_instructions: {
    container_css_class: 'myCssClass'
  } 
};
toolbar_position string defines where it will be placed inside the toolbar (default - 'right') 3 possible values: 'left', 'center' and 'right' 
var tfConfig = { 
  help_instructions: {
      toolbar_position: 'center'
  } 
};
container_adjust_left_position number adjusts container left position when table's horizontal scroll is on, typically when `responsive` option is enabled (default - 25) 
var tfConfig = { 
  help_instructions: {
      container_adjust_left_position: 50
  } 
};

Website | Examples | Es6 documentation