Skip to content

Commit 478299f

Browse files
committed
docs: update links to documentation
1 parent 2f2c5ee commit 478299f

File tree

40 files changed

+174
-107
lines changed

40 files changed

+174
-107
lines changed

src/assets/images/components.webp

60.1 KB
Binary file not shown.

src/assets/images/icons.webp

57.1 KB
Binary file not shown.

src/components/DocsCallout.js

Lines changed: 0 additions & 38 deletions
This file was deleted.

src/components/DocsComponents.js

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
import PropTypes from 'prop-types'
2+
import React from 'react'
3+
4+
import ComponentsImg from 'src/assets/images/components.webp'
5+
6+
const DocsComponents = (props) => (
7+
<div className="bg-primary bg-opacity-10 border border-2 border-primary rounded mb-4">
8+
<div className="row d-flex align-items-center p-3 px-xl-4 flex-xl-nowrap">
9+
<div className="col-xl-auto col-12 d-none d-xl-block p-0">
10+
<img
11+
className="img-fluid"
12+
src={ComponentsImg}
13+
width="160px"
14+
height="160px"
15+
alt="CoreUI PRO hexagon"
16+
/>
17+
</div>
18+
<div className="col-md col-12 px-lg-4">
19+
Our Admin Panel isn’t just a mix of third-party components. It’s{' '}
20+
<strong>
21+
the only open-source React dashboard built on a professional, enterprise-grade UI
22+
Components Library
23+
</strong>
24+
. This component is part of this library, and we present only the basic usage of it here. To
25+
explore extended examples, detailed API documentation, and customization options, refer to
26+
our docs.
27+
</div>
28+
<div className="col-md-auto col-12 mt-3 mt-lg-0">
29+
<a
30+
className="btn btn-primary text-nowrap text-white"
31+
href={`https://coreui.io/react/docs/${props.href}`}
32+
target="_blank"
33+
rel="noopener noreferrer"
34+
>
35+
Explore Documentation
36+
</a>
37+
</div>
38+
</div>
39+
</div>
40+
)
41+
42+
DocsComponents.propTypes = {
43+
href: PropTypes.string,
44+
}
45+
46+
export default DocsComponents

src/components/DocsIcons.js

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import React from 'react'
2+
3+
import IconsImg from 'src/assets/images/icons.webp'
4+
5+
const DocsIcons = () => (
6+
<div className="bg-warning bg-opacity-10 border border-2 border-warning rounded mb-4">
7+
<div className="row d-flex align-items-center p-3 px-xl-4 flex-xl-nowrap">
8+
<div className="col-xl-auto col-12 d-none d-xl-block p-0">
9+
<img className="img-fluid" src={IconsImg} width="160px" height="160px" alt="CoreUI Icons" />
10+
</div>
11+
<div className="col-md col-12 px-lg-4">
12+
CoreUI Icons package is delivered with more than 1500 icons in multiple formats SVG, PNG,
13+
and Webfonts. CoreUI Icons are beautifully crafted symbols for common actions and items. You
14+
can use them in your digital products for web or mobile app. For more information please
15+
visit our documentation.
16+
</div>
17+
<div className="col-md-auto col-12 mt-3 mt-lg-0">
18+
<a
19+
className="btn btn-warning text-nowrap text-white"
20+
href="https://coreui.io/react/docs/components/icon/"
21+
target="_blank"
22+
rel="noopener noreferrer"
23+
>
24+
Explore Documentation
25+
</a>
26+
</div>
27+
</div>
28+
</div>
29+
)
30+
31+
export default DocsIcons

src/components/index.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ import AppFooter from './AppFooter'
44
import AppHeader from './AppHeader'
55
import AppHeaderDropdown from './header/AppHeaderDropdown'
66
import AppSidebar from './AppSidebar'
7-
import DocsCallout from './DocsCallout'
7+
import DocsComponents from './DocsComponents'
8+
import DocsIcons from './DocsIcons'
89
import DocsLink from './DocsLink'
910
import DocsExample from './DocsExample'
1011

@@ -15,7 +16,8 @@ export {
1516
AppHeader,
1617
AppHeaderDropdown,
1718
AppSidebar,
18-
DocsCallout,
19+
DocsComponents,
20+
DocsIcons,
1921
DocsLink,
2022
DocsExample,
2123
}

src/views/base/accordion/Accordion.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ import {
1010
CAccordionHeader,
1111
CAccordionItem,
1212
} from '@coreui/react'
13-
import { DocsExample } from 'src/components'
13+
import { DocsComponents, DocsExample } from 'src/components'
1414

1515
const Accordion = () => {
1616
return (
1717
<CRow>
1818
<CCol xs={12}>
19+
<DocsComponents href="components/accordion" />
1920
<CCard className="mb-4">
2021
<CCardHeader>
2122
<strong>React Accordion</strong>

src/views/base/breadcrumbs/Breadcrumbs.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ import {
99
CRow,
1010
CLink,
1111
} from '@coreui/react'
12-
import { DocsExample } from 'src/components'
12+
import { DocsComponents, DocsExample } from 'src/components'
1313

1414
const Breadcrumbs = () => {
1515
return (
1616
<CRow>
1717
<CCol xs={12}>
18+
<DocsComponents href="components/breadcrumb" />
1819
<CCard className="mb-4">
1920
<CCardHeader>
2021
<strong>React Breadcrumb</strong>

src/views/base/cards/Cards.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,15 @@ import {
1919
CCol,
2020
CRow,
2121
} from '@coreui/react'
22-
import { DocsExample } from 'src/components'
22+
import { DocsComponents, DocsExample } from 'src/components'
2323

2424
import ReactImg from 'src/assets/images/react.jpg'
2525

2626
const Cards = () => {
2727
return (
2828
<CRow>
2929
<CCol xs={12}>
30+
<DocsComponents href="components/card" />
3031
<CCard className="mb-4">
3132
<CCardHeader>
3233
<strong>Card</strong> <small>Example</small>

src/views/base/carousels/Carousels.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
CCol,
1010
CRow,
1111
} from '@coreui/react'
12-
import { DocsExample } from 'src/components'
12+
import { DocsComponents, DocsExample } from 'src/components'
1313

1414
import AngularImg from 'src/assets/images/angular.jpg'
1515
import ReactImg from 'src/assets/images/react.jpg'
@@ -25,6 +25,7 @@ const Carousels = () => {
2525
return (
2626
<CRow>
2727
<CCol xs={12}>
28+
<DocsComponents href="components/carousel" />
2829
<CCard className="mb-4">
2930
<CCardHeader>
3031
<strong>Carousel</strong> <small>Slide only</small>

src/views/base/collapses/Collapses.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { useState } from 'react'
22
import { CButton, CCard, CCardBody, CCardHeader, CCol, CCollapse, CRow } from '@coreui/react'
3-
import { DocsExample } from 'src/components'
3+
import { DocsComponents, DocsExample } from 'src/components'
44

55
const Collapses = () => {
66
const [visible, setVisible] = useState(false)
@@ -11,6 +11,7 @@ const Collapses = () => {
1111
return (
1212
<CRow>
1313
<CCol xs={12}>
14+
<DocsComponents href="components/collapse" />
1415
<CCard className="mb-4">
1516
<CCardHeader>
1617
<strong>React Collapse</strong>

src/views/base/list-groups/ListGroups.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@ import {
1010
CListGroupItem,
1111
CRow,
1212
} from '@coreui/react'
13-
import { DocsExample } from 'src/components'
13+
import { DocsComponents, DocsExample } from 'src/components'
1414

1515
const ListGroups = () => {
1616
return (
1717
<CRow>
1818
<CCol xs={12}>
19+
<DocsComponents href="components/list-group" />
1920
<CCard className="mb-4">
2021
<CCardHeader>
2122
<strong>React List Group</strong> <small>Basic example</small>

src/views/base/navs/Navs.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ import {
1313
CNavItem,
1414
CNavLink,
1515
} from '@coreui/react'
16-
import { DocsExample } from 'src/components'
16+
import { DocsComponents, DocsExample } from 'src/components'
1717

1818
const Navs = () => {
1919
return (
2020
<CRow>
2121
<CCol xs={12}>
22+
<DocsComponents href="components/nav" />
2223
<CCard className="mb-4">
2324
<CCardHeader>
2425
<strong>React Navs</strong> <small>Base navs</small>

src/views/base/paginations/Paginations.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ import {
88
CPaginationItem,
99
CRow,
1010
} from '@coreui/react'
11-
import { DocsExample } from 'src/components'
11+
import { DocsComponents, DocsExample } from 'src/components'
1212

1313
const Paginations = () => {
1414
return (
1515
<CRow>
1616
<CCol xs={12}>
17+
<DocsComponents href="components/pagination" />
1718
<CCard className="mb-4">
1819
<CCardHeader>
1920
<strong>React Pagination</strong>

src/views/base/placeholders/Placeholders.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ import {
1111
CPlaceholder,
1212
CRow,
1313
} from '@coreui/react'
14-
import { DocsExample } from 'src/components'
14+
import { DocsComponents, DocsExample } from 'src/components'
1515

1616
import ReactImg from 'src/assets/images/react.jpg'
1717

1818
const Placeholders = () => {
1919
return (
2020
<CRow>
2121
<CCol xs={12}>
22+
<DocsComponents href="components/placeholder" />
2223
<CCard className="mb-4">
2324
<CCardHeader>
2425
<strong>React Placeholder</strong>
@@ -45,11 +46,10 @@ const Placeholders = () => {
4546
</CCardBody>
4647
</CCard>
4748
<CCard style={{ width: '18rem' }}>
48-
<CCardImage
49-
component="svg"
50-
orientation="top"
49+
<svg
50+
className="card-img-top"
5151
width="100%"
52-
height="162"
52+
height="180"
5353
xmlns="http://www.w3.org/2000/svg"
5454
role="img"
5555
aria-label="Placeholder"
@@ -58,7 +58,7 @@ const Placeholders = () => {
5858
>
5959
<title>Placeholder</title>
6060
<rect width="100%" height="100%" fill="#868e96"></rect>
61-
</CCardImage>
61+
</svg>
6262
<CCardBody>
6363
<CPlaceholder component={CCardTitle} animation="glow" xs={7}>
6464
<CPlaceholder xs={6} />

src/views/base/popovers/Popovers.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import React from 'react'
22
import { CButton, CCard, CCardBody, CCardHeader, CPopover, CRow, CCol } from '@coreui/react'
3-
import { DocsExample } from 'src/components'
3+
import { DocsComponents, DocsExample } from 'src/components'
44

55
const Popovers = () => {
66
return (
77
<CRow>
88
<CCol xs={12}>
9+
<DocsComponents href="components/popover" />
910
<CCard className="mb-4">
1011
<CCardHeader>
1112
<strong>React Popover</strong> <small>Basic example</small>

src/views/base/progress/Progress.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import React from 'react'
22
import { CCard, CCardBody, CCardHeader, CCol, CProgress, CProgressBar, CRow } from '@coreui/react'
3-
import { DocsExample } from 'src/components'
3+
import { DocsComponents, DocsExample } from 'src/components'
44

55
const Progress = () => {
66
return (
77
<CRow>
88
<CCol xs={12}>
9+
<DocsComponents href="components/progress" />
910
<CCard className="mb-4">
1011
<CCardHeader>
1112
<strong>React Progress</strong> <small>Basic example</small>

src/views/base/spinners/Spinners.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import React from 'react'
22
import { CButton, CCard, CCardBody, CCardHeader, CCol, CSpinner, CRow } from '@coreui/react'
3-
import { DocsExample } from 'src/components'
3+
import { DocsComponents, DocsExample } from 'src/components'
44

55
const Spinners = () => {
66
return (
77
<CRow>
88
<CCol xs={12}>
9+
<DocsComponents href="components/spinner" />
910
<CCard className="mb-4">
1011
<CCardHeader>
1112
<strong>React Spinner</strong> <small>Border</small>

src/views/base/tables/Tables.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,13 @@ import {
1313
CTableHeaderCell,
1414
CTableRow,
1515
} from '@coreui/react'
16-
import { DocsExample } from 'src/components'
16+
import { DocsComponents, DocsExample } from 'src/components'
1717

1818
const Tables = () => {
1919
return (
2020
<CRow>
2121
<CCol xs={12}>
22+
<DocsComponents href="components/table" />
2223
<CCard className="mb-4">
2324
<CCardHeader>
2425
<strong>React Table</strong> <small>Basic example</small>

src/views/base/tabs/Tabs.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ import {
1111
CTabPanel,
1212
CTabs,
1313
} from '@coreui/react'
14-
import { DocsExample } from 'src/components'
14+
import { DocsComponents, DocsExample } from 'src/components'
1515

1616
const Navs = () => {
1717
return (
1818
<CRow>
1919
<CCol xs={12}>
20+
<DocsComponents href="components/tabs" />
2021
<CCard className="mb-4">
2122
<CCardHeader>
2223
<strong>React Tabs</strong>

src/views/base/tooltips/Tooltips.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
import React from 'react'
22
import { CButton, CCard, CCardBody, CCardHeader, CLink, CTooltip, CRow, CCol } from '@coreui/react'
3-
import { DocsExample } from 'src/components'
3+
import { DocsComponents, DocsExample } from 'src/components'
44

55
const Tooltips = () => {
66
return (
77
<CRow>
88
<CCol xs={12}>
9+
<DocsComponents href="components/tooltip" />
910
<CCard className="mb-4">
1011
<CCardHeader>
1112
<strong>React Tooltip</strong> <small>Basic example</small>

0 commit comments

Comments
 (0)