1.0.1 • Published 6 years ago
react-text-panel v1.0.1
Setting up your component
Delete this section after you've setup the component
Before the component is accepted into the DLS:
Github
: Create the repository under your own username/organisation
When the component is accepted into the DLS:
Github
: Transfer ownership of the repository tofrontend
BuildKite
: Create aNew Pipeline
BuildKite
: Enter the following settings:
- Name:
react-text-panel
- Git Repository:
git@git.nib.com.au:frontend/react-text-panel.git
BuildKite
:Remove
the defaultStep
and add aRead steps from repository
step
- And add
cd deploy && bundle install && bundle update sceptre sceptre-dotnet sceptre-app && bundle exec sceptre-app pipeline upload
to the Commands to run textbox - And add
os=linux
to the Agent Targeting Rules textbox
BuildKite
:Create Pipeline
and follow the instructions to add the webhook to GithubEnterpriseBuildKite
: Go toSettings
- Check
Build pull requests from third-party forked repositories
and clickSave Github Enterprise Settings
- Copy the
Markdown
badge fromSettings
and past it below.
Github
: Edit the readme to remove these steps and kick off aNew build
Github
: Protect themaster
branch
- Go to
Settings
>Branches
- Choose the
master
branch - Check
Protect this branch
- Check
Require status checks to pass before merging
- Check
Include administrators
andRequire branches to be up to date before merging
- Check all
Status checks found in the last week for this repository
@nib-components/react-text-panel
A react-text-panel component.
Installation
npm install --save react-text-panel
Usage
import TextPanel from 'react-text-panel';
<TextPanel/>
<ReactTextPanel/>
Properties
text
The text to be displayed (Can be markdown)
Required. An string
.
title
Title of the panel
Optional. A string
.
titleSize
Heading size of the title
Optional. A string
. Defaults to '2'
.
wrapperClassName
wrapperClassName
Optional. A string
.
titleClassName
titleClassName
Optional. A string
.
textClassName
textClassName
Optional. A string
.
Change log
1.0.0
Initial release.
Contributing
You can edit the files in ./src
, whilst running npm run watch
. This will compile for the ./dist
folder.