Code Monkey home page Code Monkey logo

docs's Introduction

Webix UI Docs

Those are sources of http://docs.webix.com

  • all text pages are in the "data" folder
  • all images are in the "media" folder

Offline version

CHM version of Webix documention - http://docs.webix.com/chm/webix.zip

Differences from MarkDown

  • Tabs or 4+ spaces are used to separate two-column lists

    - line	cells with border (default)
    - clean	cells without border
    - wide	cells with border and small space between siblings
    - space	cells with border and wide space between siblings
    - head	similar to "wide", but there is any border between the first and second cells
    

    =>

    Screenshot

  • triple-tilde, ~~~ is used instead of ``` for code sections

    ~~~js
    webix.ui({
        view: "list",
        template: "#title#"
    }); // this list will show 'titles'
    ~~~

Autogenerated API files

It is useless to edit "ref" and "toc" pages (files containing "refs" or "toc" in the path).

Per-component reference pages are autogenerated from @short sections of child API articles, so it is enough to edit the @short section of the related article.

Summarizing tables of contents for UI components and mixins, or "toc" pages,
are autogenerated from {{memo }} sections of the related articles in the "obj" folder.

These memos are also included into component/mixin summarising pages (like DataLoader or Accordion) as a first line.

Both {{memo }} and @short sections are laconic descriptions of the functionality and, if possible, should be shortened to one line of text.

docs's People

Contributors

dandv avatar helgalistopad avatar mafanya23 avatar maria-staskova avatar mkozhukh avatar mstaskova avatar nickmaksimenko avatar zwillinge avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

onChange event on uploader wont work

I have build UI using webix, but I have trouble on using event onChange on component uploder, I have tried example code on webix docs but it still not work, any advice? thank you

how to set value and text to an combo with suggest feature.

my question is how to set value and text to a combo with suggest feature.
code is like this
{
view: 'combo',
id: 'combo_allusers',
suggest: getSuggest()
}`

getSuggest is a customized method which returns a object as the following:
{
template: '',
scheme: {
$init: function(item) {this.changeId(item.id, item.userId)}
}
dataFeed: {
$proxy: true,
load: function(view, callback, details) {
let $callback = partial(webix.ajax.$callback, view, callback); // partial is from lodash
let mycallback = {
success: function(text, data, loader) {
$callback(text, data, loader, false);
},
error: function(text, data, loader) {
$callback(text, data, loader, true);
}
};
webix.ajax().headers({
'Content-Type' : 'application/json'
}).timeout(2000).get(url, {['userCN']: 'whatever-string'},mycallback);
}
}
}

What I want to do is as:
'$$('combo_allusers').setValue(1);' // 1 is the id that I already know. I can get the text for id 1 as well.
of course this code doesn't help. I read some some message that You cannot ignore the suggest list and enter you own text from docs of 'http://docs.webix.com/desktop__suggest.html'. but I'm not sure if the message means that we don't have any method to set value to a combo with suggest component.

Overflow hidden

Mac users like me have some problems with chm version.

We cannot scroll down the page because of overflow:hidden attribute.

Ensure consistent tabs vs. spaces

How can we ensure a consistent use of tabs vs. spaces throughout the documentation (and codebase)?

The majority of JS code out there uses spaces (no tabs, because they can be rendered at arbitrary widths - 2, 4, 8), Douglas Crockford also recommends using spaces.

Regardless the choice, it would be good to be consistent about it. Webix documentation uses a mix of tabs and spaces. So far, I've converted the tabs to spaces for uniformity (see for example 1e75c6a).

What is madoka?

I've found this

require_once("../madoka/core/index.php");

in docs/index.php. Where can i get this?

And codebase/core/docs_add.js , codebase/core/docs_remove.js ?

DataTable columns Drag'n'Drop Events

DataTable columns Drag'n'Drop Events doc description stating that handler function takes complex context object as a parameter, actually there are string source columnId for 'drag' event and sourceId, targetId for the 'drop' one with no any context object.

How can help?

Some config variables newer described in documentation. I think documentation should be better.
For example oped docs for ui.form in example used config variable "elements", but nowhere was described. I think this should be described in Values mixin. Same problem with ui.headerlayout.header, ui.view.autoheight. Would be better for each method or variable show which class is declare method or variable, if not overwritted in current class, example

ui.form

  • bind (BaseBind)
  • css (ui.baseview)
  • container (ui.baseview)
  • elements (Values)
  • id (Settings)

Where i can commit fixes for docs?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.