openedx.core.djangoapps.plugin_api package

openedx.core.djangoapps.plugin_api package#

Views for building plugins.

class openedx.core.djangoapps.plugin_api.views.EdxFragmentView(**kwargs)#

Bases: FragmentView

The base class of all Open edX fragment views.

add_fragment_resource_urls(fragment)#: Adds URLs for JS and CSS resources needed by this fragment.

create_base_standalone_context(request, fragment, **kwargs)#: Creates the base context for rendering a fragment as a standalone page.

css_dependencies()#: Returns list of the CSS files that this view depends on.

static get_css_dependencies(group)#

Returns list of CSS dependencies belonging to group in settings.PIPELINE[‘JAVASCRIPT’].

Respects PIPELINE[‘PIPELINE_ENABLED’] setting.

static get_js_dependencies(group)#

Returns list of JS dependencies belonging to group in settings.PIPELINE[‘JAVASCRIPT’].

Respects PIPELINE[‘PIPELINE_ENABLED’] setting.

js_dependencies()#: Returns list of the JavaScript files that this view depends on.

render_standalone_response(request, fragment, **kwargs)#

Renders a standalone page for the specified fragment.

Note: if fragment is None, a 204 response will be returned (no content).

standalone_page_title(request, fragment, **kwargs)#: Returns the page title for the standalone page, or None if there is no title.

vendor_js_dependencies()#: Returns list of the vendor JS files that this view depends on.