46 lines
1.9 KiB
TypeScript
46 lines
1.9 KiB
TypeScript
|
// (C) Copyright 2015 Martin Dougiamas
|
||
|
|
//
|
||
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
// you may not use this file except in compliance with the License.
|
||
|
|
// You may obtain a copy of the License at
|
||
|
|
//
|
||
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
//
|
||
|
|
// Unless required by applicable law or agreed to in writing, software
|
||
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
// See the License for the specific language governing permissions and
|
||
|
|
// limitations under the License.
|
||
|
|
|
||
|
|
import { Component, Input } from '@angular/core';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Component to display the description of a module.
|
||
|
|
*
|
||
|
|
* This directive is meant to display a module description in a similar way throughout all the app.
|
||
|
|
*
|
||
|
|
* You can add a note at the right side of the description by using the 'note' attribute.
|
||
|
|
*
|
||
|
|
* You can also pass a component and componentId to be used in format-text.
|
||
|
|
*
|
||
|
|
* Module descriptions are shortened by default, allowing the user to see the full description by clicking in it.
|
||
|
|
* If you want the whole description to be shown you can use the 'showFull' attribute.
|
||
|
|
*
|
||
|
|
* Example usage:
|
||
|
|
*
|
||
|
|
* <core-course-module-description [description]="myDescription"></core-course-module-description
|
||
|
|
*/
|
||
|
|
@Component({
|
||
|
|
selector: 'core-course-module-description',
|
||
|
|
templateUrl: 'module-description.html'
|
||
|
|
})
|
||
|
|
export class CoreCourseModuleDescriptionComponent {
|
||
|
|
@Input() description: string; // The description to display.
|
||
|
|
@Input() note?: string; // A note to display along with the description.
|
||
|
|
@Input() component?: string; // Component for format text directive.
|
||
|
|
@Input() componentId?: string|number; // Component ID to use in conjunction with the component.
|
||
|
|
@Input() showFull?: string|boolean; // Whether to always display the full description.
|
||
|
|
|
||
|
|
constructor() {}
|
||
|
|
}
|