Talk:VisualEditor/API/Data Model/Surface

This page used the Structured Discussions extension to give structured discussions. It has since been converted to wikitext, so the content and history here are only an approximation of what was actually displayed at the time these comments were made.

Request for clarification

Latest comment: 6 years ago1 comment1 person in discussion

Beginner feedback: I would love to see a paragraph added, explaining how to get a surfaceModel. Adamw (talk) 11:49, 7 October 2019 (UTC)Reply

I would love to see a paragraph added, explaining all methods of fragments like insertContent etc.

Structures here - is objects or variable in JSON format, that need to insert content in fragment, which is not wrapped in

<nowiki>

tags, allowing you to add content with wiki markup.

Examples of permitted structures

Adding redirect to Page

var redirectContent = [{
						type: 'mwRedirect',
						attributes: {title: 'Page'}
					  }];
fragment.collapseToStart().insertContent(redirectContent);

Template with values

[{
    type: 'mwTransclusionBlock',
    attributes: {
        mw: {
            parts: [
                {
                    template: {
                        target: { href: 'Template:MyTemplate', wt: 'MyTemplate' },
                        params: { 1: { wt: 'my parameter' } }
                    }
                }
            ]
        }
    }
},
{ type: '/mwTransclusionBlock' } /*???*/]

Links

[{
    type: 'link',
    attributes: {
        href: 'https://example.com',
        title: 'Пример ссылки'
    },
    content: 'Пример ссылки'
}]

Images

[{
    type: 'image',
    attributes: {
        src: 'File:Example.jpg',
        alt: 'Пример изображения'
    }
}]