superdesk-ui-framework 3.0.0-beta.0 → 3.0.0-rc12

package/dist/react/Container.tsx

@@ -0,0 +1,143 @@
+import * as React from 'react';
+import * as Markup from '../../js/react';
+import { PropsList, Prop, Container, Text, Heading, Button, ButtonGroup } from '../../../app-typescript';
+
+interface IProps {
+    children?: React.ReactNode;
+}
+
+export default class ContainerDoc extends React.Component<IProps> {
+    render() {
+        return (
+            <section className='docs-page__container'>
+                <h2 className='docs-page__h2'>Container</h2>
+                
+                <Markup.ReactMarkupCodePreview>{`
+                    <Container>
+                        Cum sociis natoque penatibus et magnis dis parturient...
+                    </Container>
+                `}
+                </Markup.ReactMarkupCodePreview>
+
+                <p className="docs-page__paragraph">
+                    The Container is a convenient layout component with different layout options and support for external CSS classes.
+                    The display model is <code>flex</code> by default, but can be changed with the <code>display</code> prop. It is 
+                    intended to be used with helper CSS classes to achieve desired styling options
+                </p>
+
+                <Markup.ReactMarkup>
+                    <Markup.ReactMarkupPreview>
+                        <p className="docs-page__paragraph">// Basic</p>
+                        <div className='docs-page__content-row'>
+                            <Container>
+                                Large size, justified. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Sed posuere consectetur
+                                est at lobortis. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Morbi leo risus, porta ac
+                                consectetur ac, vestibulum at eros. Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare
+                                sem lacinia quam venenatis vestibulum. 
+                            </Container>
+                        </div>
+
+                        <p className="docs-page__paragraph">// Usage examples</p>
+
+                        <div className='docs-page__content-row'>
+                            <Container gap="large" className='sd-border--medium sd-font-size--medium sd-padding--2 sd-radius--large'>
+                                <span>Curabitur blandit tempus porttitor.</span>
+                                <Button text="Test button" type="primary" onClick={()=> false} />
+                                <Button text="Test button" type="highlight" onClick={()=> false} />
+                                <ButtonGroup align="end">
+                                    <Button text="Cancel" onClick={()=> false} type="default" style="hollow" />
+                                    <Button text="Submit" onClick={()=> false} type="primary" />
+                                </ButtonGroup>
+                            </Container>
+                        </div>
+
+                        <div className='docs-page__content-row'>
+                            <Container gap="large" direction='column' className='sd-radius--medium sd-panel-bg--000 sd-shadow--z2 sd-padding--3 sd-state--focus'>
+                                <Heading type='h3'>Curabitur blandit tempus porttitor.</Heading>
+                                <Text color='light'>
+                                    Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
+                                    Sed posuere consectetur est at lobortis. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+                                    Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Integer posuere erat a ante venenatis dapibus
+                                    posuere velit aliquet. Aenean eu leo quam.
+                                </Text>
+                                <ButtonGroup align="end">
+                                    <Button text="Cancel" onClick={()=> false} type="default" style="hollow" />
+                                    <Button text="Submit" onClick={()=> false} type="primary" />
+                                </ButtonGroup>
+                            </Container>
+                        </div>
+
+                        <div className='docs-page__content-row'>
+                            <Container gap="large" theme='dark' direction='column' className='sd-radius--medium sd-panel-bg--000 sd-shadow--z2 sd-padding--3 sd-state--focus'>
+                                <Heading type='h3'>Curabitur blandit tempus porttitor.</Heading>
+                                <Text color='light'>
+                                    Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
+                                    Sed posuere consectetur est at lobortis. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+                                    Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Integer posuere erat a ante venenatis dapibus
+                                    posuere velit aliquet. Aenean eu leo quam.
+                                </Text>
+                                <ButtonGroup align="end">
+                                    <Button text="Cancel" onClick={()=> false} type="default" style="hollow" />
+                                    <Button text="Submit" onClick={()=> false} type="primary" />
+                                </ButtonGroup>
+                            </Container>
+                        </div>
+                        
+                    </Markup.ReactMarkupPreview>
+                    <Markup.ReactMarkupCode>{`
+                        // Basic
+
+                        <Container>
+                            Large size, justified. Praesent commodo cursus magna, vel scelerisque nisl consectetur et... 
+                        </Container>
+
+                        // Usage examples
+
+                        <Container gap="large" className='sd-border--medium sd-font-size--medium sd-padding--2 sd-radius--large'>
+                            <span>Curabitur blandit tempus porttitor.</span>
+                            <Button text="Test button" type="primary" onClick={()=> false} />
+                            <Button text="Test button" type="highlight" onClick={()=> false} />
+                            <ButtonGroup align="end">
+                                <Button text="Cancel" onClick={()=> false} type="default" style="hollow" />
+                                <Button text="Submit" onClick={()=> false} type="primary" />
+                            </ButtonGroup>
+                        </Container>
+
+                        <Container gap="large" direction='column' className='sd-radius--medium sd-panel-bg--000 sd-shadow--z2 sd-padding--3 sd-state--focus'>
+                            <Heading type='h3'>Curabitur blandit tempus porttitor.</Heading>
+                            <Text color='light'>
+                                Praesent commodo cursus magna, vel scelerisque nisl consectetur et...
+                            </Text>
+                            <ButtonGroup align="end">
+                                <Button text="Cancel" onClick={()=> false} type="default" style="hollow" />
+                                <Button text="Submit" onClick={()=> false} type="primary" />
+                            </ButtonGroup>
+                        </Container>
+
+                        <Container gap="large" theme='dark' direction='column' className='sd-radius--medium sd-panel-bg--000 sd-shadow--z2 sd-padding--3 sd-state--focus'>
+                        <Heading type='h3'>Curabitur blandit tempus porttitor.</Heading>
+                        <Text color='light'>
+                            Praesent commodo cursus magna, vel scelerisque nisl consectetur et...
+                        </Text>
+                        <ButtonGroup align="end">
+                            <Button text="Cancel" onClick={()=> false} type="default" style="hollow" />
+                            <Button text="Submit" onClick={()=> false} type="primary" />
+                        </ButtonGroup>
+                    </Container>
+  
+                    `}
+                    </Markup.ReactMarkupCode>
+                </Markup.ReactMarkup>
+
+                <h3 className="docs-page__h3">Props</h3>
+                <PropsList>
+                    <Prop name='display' isRequired={false} type='flex | inline-flex | block' default='flex' description='Change the default display mode (flex).'/>
+                    <Prop name='direction' isRequired={false} type='row | column' default='row' description='Change the flex-direction property.'/>
+                    <Prop name='gap' isRequired={false} type='none | x-small | small |  medium | large' default='none' description='Set the gap between elements inside the Container.'/>
+                    <Prop name='theme' isRequired={false} type='light | dark' default='/' description='Choose the UI theme. It will inherit the default theme if not set. All items inside will inherit the theme of the Container if it is set.'/>
+                    <Prop name='className' isRequired={false} type='string' default='/' description='Add helper classes or custom CSS styles'/>
+                </PropsList>
+            </section>
+        )
+    }
+}

package/dist/react/ContentDivider.tsx

@@ -32,11 +32,12 @@ export default class ContentDividerDoc extends React.Component {
                             consectetur adipiscing elit. Nullam quis risus eget urna mollis ornare vel eu leo.
                             Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Cras mattis consectetur
                             purus sit amet fermentum. Nulla vitae elit libero, a pharetra augue.</p>
-                            <ContentDivider type="dotted" />
+                            <ContentDivider type="dotted" margin='x-small' />
                             <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce dapibus, tellus
                             ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet
                             risus. Donec id elit non mi porta gravida at eget metus. Cras justo odio, dapibus ac
                             facilisis in, egestas eget quam.</p>
+                            <ContentDivider type="dotted" margin='x-small' />
                         </div>
                     </Markup.ReactMarkupPreview>
                     <Markup.ReactMarkupCode>{`
@@ -50,9 +51,11 @@ export default class ContentDividerDoc extends React.Component {
 
                         <p>Donec ullamcorper nulla non metus auctor fringilla...</p>
 
-                        <ContentDivider type="dotted" />
+                        <ContentDivider type="dotted" margin='x-small' />
 
                         <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit...</p>
+
+                        <ContentDivider type="dotted" margin='x-small' />
                     `}
                     </Markup.ReactMarkupCode>
                 </Markup.ReactMarkup>
@@ -69,15 +72,15 @@ export default class ContentDividerDoc extends React.Component {
                             Maecenas faucibus mollis interdum. Donec ullamcorper nulla non metus
                             auctor fringilla. Aenean eu leo quam. Pellentesque ornare sem lacinia
                             quam venenatis vestibulum.</p>
-                            <ContentDivider align="left">
-                                Left aligned
+                            <ContentDivider margin='small' align="left">
+                                Left aligned, small margin
                             </ContentDivider>
                             <p>Maecenas sed diam eget risus varius blandit sit amet non magna.
                             Donec id elit non mi porta gravida at eget metus. Cras mattis consectetur
                             purus sit amet fermentum. Etiam porta sem malesuada magna mollis euismod.
                             Cras mattis consectetur purus sit amet fermentum.</p>
                             <ContentDivider align="right" type="dotted">
-                                Right aligned
+                                Right aligned, dotted
                             </ContentDivider>
                             <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et.
                             Donec id elit non mi porta gravida at eget metus. Praesent commodo cursus magna,
@@ -93,14 +96,14 @@ export default class ContentDividerDoc extends React.Component {
 
                         <p>Maecenas sed diam eget...</p>
 
-                        <ContentDivider align="left">
-                            Left aligned
+                        <ContentDivider margin='small' align="left">
+                            Left aligned, small margin
                         </ContentDivider>
 
                         <p>Maecenas sed diam eget risus...</p>
 
                         <ContentDivider align="right" type="dotted">
-                            Right aligned
+                            Right aligned, dotted
                         </ContentDivider>
 
                         <p>Praesent commodo cursus magna...</p>
@@ -115,9 +118,9 @@ export default class ContentDividerDoc extends React.Component {
                         <p className="docs-page__paragraph">// Basic</p>
                         <div className='docs-page__content-row'>
                             <span>Option one</span>
-                            <ContentDivider orientation="vertical" type="dotted" />
+                            <ContentDivider margin='small' orientation="vertical" type="dotted" />
                             <span>Option two</span>
-                            <ContentDivider orientation="vertical" type="dotted" />
+                            <ContentDivider margin='small' orientation="vertical" type="dotted" />
                             <span>Option three</span>
                         </div>
                         <p className="docs-page__paragraph ">// With text</p>
@@ -129,7 +132,7 @@ export default class ContentDividerDoc extends React.Component {
                                 sit amet. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Aenean lacinia bibendum nulla
                                 sed consectetur. Vivamus sagittis lacus vel augue.
                             </div>
-                            <ContentDivider orientation="vertical">
+                            <ContentDivider orientation="vertical" margin='large'>
                                 or
                             </ContentDivider>
                             <div style={{width:'100%'}}>
@@ -143,9 +146,9 @@ export default class ContentDividerDoc extends React.Component {
                         // Basic
 
                         <span>Option one</span>
-                        <ContentDivider orientation="vertical" type="dotted" />
+                        <ContentDivider margin='small' orientation="vertical" type="dotted" />
                         <span>Option two</span>
-                        <ContentDivider orientation="vertical" type="dotted" />
+                        <ContentDivider margin='small' orientation="vertical" type="dotted" />
                         <span>Option three</span>
 
                         // With text
@@ -154,7 +157,7 @@ export default class ContentDividerDoc extends React.Component {
                             Cras justo odio, dapibus ac facilisis in, egestas eget quam...
                         </div>
 
-                        <ContentDivider orientation="vertical">
+                        <ContentDivider orientation="vertical" margin='large'>
                             or
                         </ContentDivider>
 
@@ -167,10 +170,11 @@ export default class ContentDividerDoc extends React.Component {
 
                 <h3 className="docs-page__h3">Props</h3>
                 <PropsList>
-                    <Prop name='type' isRequered={false} type='dashed | dotted | solid' default='solid' description='Border style of the divider.'/>
-                    <Prop name='orientation' isRequered={false} type='horizontal | vertical' default='horizontal' description='Defines if the divider is horizontal or vertical. Default is horizontal.'/>
-                    <Prop name='align' isRequered={false} type='center | left | right' default='right' description='Text alignment inside the divider. Should not be used without any text inside the divider. The vertical divider has no alignment options.'/>
-                    <Prop name='border' isRequered={false} type='boolean' default='true' description='Removes the border if set to true. Should be generally avoided especially if there is textual content. It can be used to add space between elements if there is no other option.'/>
+                    <Prop name='type' isRequired={false} type='dashed | dotted | solid' default='solid' description='Border style of the divider.'/>
+                    <Prop name='orientation' isRequired={false} type='horizontal | vertical' default='horizontal' description='Defines if the divider is horizontal or vertical. Default is horizontal.'/>
+                    <Prop name='align' isRequired={false} type='center | left | right' default='right' description='Text alignment inside the divider. Should not be used without any text inside the divider. The vertical divider has no alignment options.'/>
+                    <Prop name='border' isRequired={false} type='boolean' default='true' description='Removes the border if set to true. Should be generally avoided especially if there is textual content. It can be used to add space between elements if there is no other option.'/>
+                    <Prop name='margin' isRequired={false} type='x-small | small | medium | large | none' default='medium' description='Vertical or horizontal margins (depending on the orientation) of the ContentDivider. Default to medium if not set.'/>
                 </PropsList>
             </section>
         )