Skip to content

Commit

Permalink
docs: platform docs cleanup (#2718)
Browse files Browse the repository at this point in the history
  • Loading branch information
droshev committed Jun 19, 2020
1 parent f12b02e commit 66bf307
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 57 deletions.
@@ -1,6 +1,6 @@
<fd-docs-section-title [id]="'Button-types'" [componentName]="'button'"> Button Types </fd-docs-section-title>
<description>
The default button type is "action", no modifier is required. Use
The default button does not require modifier. Use
<code class="code-snippet">[type]="'standard'", [type]="'positive'", [type]="'medium'"</code>, or
<code class="code-snippet">[type]="'negative'"</code> to modify the type of the button.
</description>
Expand All @@ -11,7 +11,7 @@
<separator></separator>

<fd-docs-section-title [id]="'Button-sizes'" [componentName]="'button'"> Button Sizes </fd-docs-section-title>
<description> Use <code class="code-snippet">[compact]="true"</code> for the mobile button size. </description>
<description> Button support two sized: compact and cozy </description>
<component-example>
<fdp-button-sizes-example></fdp-button-sizes-example>
</component-example>
Expand All @@ -35,17 +35,16 @@
Button State
</fd-docs-section-title>
<description>
[disabled]="true" makes the button disabled, when we make it false, it won't be disabled any more, by default
disabled is set to false.
<code>[disabled]="true"</code> sets the button disabled
</description>
<component-example>
<fdp-button-state-example></fdp-button-state-example>
</component-example>
<code-example [exampleFiles]="buttonHtmlState"></code-example>

<separator></separator>
<!-- <separator></separator> -->

<fd-docs-section-title [id]="'Button-truncate'" [componentName]="'button'">
<!-- <fd-docs-section-title [id]="'Button-truncate'" [componentName]="'button'">
Button with long text truncated
</fd-docs-section-title>
<description>
Expand All @@ -55,27 +54,4 @@
<component-example>
<fdp-button-truncate-example></fdp-button-truncate-example>
</component-example>
<code-example [exampleFiles]="buttonHtmlTruncate"></code-example>

<separator></separator>

<description
>The inputs for <code>button</code> will be translated into classes attributed to fundamental-styles guidelines.
<br />For example: <br />if <code>positive</code> is passed for <code>type</code>, the class
<code>fd-button--positive</code> will be added to the element. <br />if <code>compact</code> is passed for
<code>size</code>, the class <code>fd-button--compact</code> will be added to the element.
</description>
<separator></separator>

<playground [schema]="schema" [schemaInitialValues]="data" (onFormChanges)="onSchemaValues($event)">
<fdp-button
[type]="data.properties.type"
[compact]="data.properties.compact"
[disabled]="data.properties.disabled"
[attr.title]="data.properties.label"
[width]="data.properties.width"
[glyph]="data.properties.icon"
>
{{ data.properties.label }}
</fdp-button>
</playground>
<code-example [exampleFiles]="buttonHtmlTruncate"></code-example> -->
@@ -1,8 +1,6 @@
<header>Button</header>
<description>
The Button Component is used to enhance standard HTML buttons.
<br /><br />
Buttons can be navigated to via the tab key and pressed with the space bar or enter key.
The Button Component is used to simplify the usage of the button from the <a [routerLink]="'/core/button'">core package</a>.
</description>
<import module="PlatformButtonModule"></import>

Expand Down
@@ -1,23 +1,18 @@
<header>Checkbox</header>
<description>
This is an extension of the Checkbox component present in
<a href="https://sap.github.io/fundamental-ngx/#/core/checkbox">ngx-core</a>. <br />
It is wrapper implemention to work with
<a href="https://sap.github.io/fundamental-ngx/#/platform/form">Platform Form</a>. It can also be used standalone
without form. <br />
<a [routerLink]="'/core/checkbox'">ngx-core</a>. <br />
For usecase of Multiple checkboxes selection, please see
<a href="https://sap.github.io/fundamental-ngx/#/platform/checkbox-group">Checkbox Group</a>.
<a [routerLink]="'/platform/checkbox'">Checkbox Group</a>.

<div>
<h3 style="margin-bottom: 1rem;">Platform specific enhancements:</h3>
<ul style="margin-top: 0%;">
<li>
Platform checkbox takes checked state value as a property. so when checkbox is in checked state, control
value will be set to value of checkbox.
</li>
<li>Platform checkbox can be used outside form using "checked" property two way binding.</li>
</ul>
</div>
<h3>Platform specific enhancements:</h3>
<ul>
<li>
Platform checkbox takes checked state value as a property. so when checkbox is in checked state, control
value will be set to value of checkbox.
</li>
<li>Platform checkbox can be used outside form using "checked" property two way binding.</li>
</ul>
</description>
<import module="PlatformCheckboxModule"></import>

Expand Down
@@ -1,8 +1,10 @@
<header>Info Label</header>
<description>
<p>Info Label in Platform provides same functionalities that is present in @fudamental-ngx/core.</p>
<p> - Info Label is introduced as a angular component to have ability to work programatically with this component. </p>
<p> - Info Label offers accessibility support. </p>
<h3>Info Label in Platform provides same functionalities that is present in @fudamental-ngx/core.</h3>
<ul>
<li>Info Label is introduced as a angular component to have ability to work programatically with this component. </li>
<li>Info Label offers accessibility support. </li>
</ul>
</description>
<import module="platformInfoLabelModule"></import>

Expand Down
Expand Up @@ -9,11 +9,11 @@ <h3>Platform specific enhancements:</h3>
<li>
Integration of Menu with use of fdpMenuTriggerFor directive. <br />
(More information on fdpMenuTriggerFor directive available in
<a href="https://sap.github.io/fundamental-ngx/#/platform/menu">Platform Menu</a>.)
<a [routerLink]="'/platform/menu'">Platform Menu</a>.)
</li>
</ul>
</description>
<pre style="background-color: #e9e7e7;"><import module="PlatformSplitMenuButtonModule"></import></pre>
<import module="PlatformSplitMenuButtonModule"></import>

<fd-header-tabs></fd-header-tabs>
<router-outlet></router-outlet>
Expand Up @@ -14,10 +14,6 @@ export class PlatformCheckboxChange {
}

/**
* Checkbox implementation based on the
* https://github.com/SAP/fundamental-ngx/wiki/Platform:-Checkbox-Component-Technical-Design
* documents.
*
* This implementation behaves like implementation in PrimeNg and Material checkbox implementation.
* Some part of code/idea has been taken from above mentioned and has been implemented to work with platform form.
* primeng: https://primefaces.org/primeng/showcase/#/checkbox
Expand Down

0 comments on commit 66bf307

Please sign in to comment.