Skip to content
This repository has been archived by the owner on Jan 24, 2021. It is now read-only.

Icon Export API #6

Closed
28 tasks
Templarian opened this issue Oct 3, 2016 · 3 comments
Closed
28 tasks

Icon Export API #6

Templarian opened this issue Oct 3, 2016 · 3 comments

Comments

@Templarian
Copy link
Owner

Templarian commented Oct 3, 2016

A single endpoint to download any output of the icons in.

[{
    "id": "",
    "name": null,
    "type": "png",
    "path": [],
    "width": 24,
    "height": 24,
    "padding": 10,
    "paddingTop": 10,
    "paddingRight": 10,
    "paddingBottom": 10,
    "paddingLeft": 10,
    "foreground": "#FFFFFF",
    "foregroundOpacity": 1,
    "background": "#000000",
    "backgroundOpacity": 1,
    "radius": 10,
    "borderWidth": 1,
    "borderColor": "#990000",
    "borderOpacity": 1,
    "borderCap": "round",
    "borderArray": [4, 4],
    "margin": 10,
    "marginTop": 10,
    "marginRight": 10,
    "marginBottom": 10,
    "marginLeft": 10,
    "gridColor": "#F0F0F0",
    "gridOpacity": 1,
    "matteColor": "#FFFFFF",
    "matteOpacity": 1,
}]

1 All undefined/null properties default. Numbers 0, Colors transparent
2 path = array of folder strings. [] (default)
3 borderCap = butt / square / round (default)
4 borderArray standard border array. [1] (default aka a solid line)
5 grid requires at least 72x72. 24x24 grid size.

If more than one item the icon is assumed to be a zip file.

  • id (required)
  • name = icon name
  • path = []
  • width = 24
  • height = 24
  • padding = 0
  • paddingTop = 0
  • paddingRight = 0
  • paddingBottom = 0
  • paddingLeft = 0
  • foreground = #000000
  • foregroundOpacity = 1
  • background = transparent
  • backgroundOpacity = 1
  • radius = 0
  • borderWidth = 0
  • borderColor = #000000
  • borderCap = round
  • borderArray = [1]
  • margin = 0
  • marginTop = 0
  • marginRight = 0
  • marginBottom = 0
  • marginLeft = 0
  • gridColor = #F0F0F0
  • gridOpacity = 1
  • matteColor = #FFFFFF
  • matteOpacity = 1
@Templarian
Copy link
Owner Author

Started coding this endpoint. This is a fun endpoint since it will handle so much functionality. Coding in the ability for a few different file types. svg, png, xaml, and vector-drawable.

The official docs for the API have more details,
https://github.com/Templarian/MaterialDesign-Site/blob/master/src/content/api.md

@splitbrain
Copy link

This is tagged with help wanted, but I can't seem to find the sources? src/api seems to consist of mockups only currently, however parts of the api you describe seem to be in place and working already. Could you give some info about the state of this issue and some pointers where to start with helping?

@Templarian
Copy link
Owner Author

Templarian commented Aug 25, 2017

@splitbrain Mostly the help wanted is for how the endpoint looks and if it has the features you need. Actually have a good chunk of this endpoint coded already.

I won't be opening up the source for these for a while (eventually, but not on the road map until the new site launches). Basically this repo is for the front end (which is going slowly as I am very busy during the summer).

Need to document the database and setup a test environment for contributors.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants